Skip to content

Commit

Permalink
docs: update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pnts-se committed Jan 20, 2023
1 parent 53304bf commit 206b777
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Edumeet App Configuration
# Edumeet client

This is the client service for the Edumeet project.


![](img/edumeet-client.drawio.png)

## Configuration
The app configuration file should be a valid javascript file defining a single
`config` object containing the properties that you need to modify.

Expand All @@ -18,9 +24,9 @@ can be found here: [config.example.js](public/config/config.example.js).
| Name | Description | Format | Default value |
| :--- | :---------- | :----- | :------------ |
| loginEnabled | If the login is enabled. | `"boolean"` | ``false`` |
| developmentPort | The development server listening port. | `"port"` | ``3443`` |
| productionPort | The production server listening port. | `"port"` | ``8443`` |
| serverHostname | If the server component runs on a different host than the app you can specify the host name. | `"string"` | ``""`` |
| developmentPort | The development room server service listening port. | `"port"` | ``3443`` |
| productionPort | The production room server service listening port. | `"port"` | ``8443`` |
| serverHostname | If the room server service runs on a different host than the client service you can specify the host name. | `"string"` | ``""`` |
| resolution | The default video camera capture resolution. | `[ "low", "medium", "high", "veryhigh", "ultra"]` | ``"medium"`` |
| frameRate | The default video camera capture framerate. | `"nat"` | ``15`` |
| screenResolution | The default screen sharing resolution. | `[ "low", "medium", "high", "veryhigh", "ultra"]` | ``"veryhigh"`` |
Expand Down
Binary file added img/edumeet-client.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 206b777

Please sign in to comment.