@@ -58,17 +58,18 @@ Commands (PTZ, Pan Tilt Zoom) issued from your browser are forwarded to the Node
58
58
## Installation / Getting Started
59
59
1 . Copy the ` docker-compose.prod.yml ` template to wherever you want to deploy the application
60
60
1 . Replace the ` ${DOCKER_NGINX_VERSION} ` variable with your desired nginx version
61
- 1 . Create the ` config.json ` configuration file
61
+ 1 . Create the ` config.toml ` configuration file
62
62
1 . Copy the nginx configuration template from ` nginx/nginx.conf ` and configure to your liking
63
63
1 . ` docker-compose up -d `
64
64
65
65
### Custom Encoding
66
66
If you want to re-encode video streams, modify the ` ffmpeg-wrapper.sh ` script to your requirements and bind-mount it into the backend container.
67
67
68
68
### Configuration
69
- The application is configured using a ` .json ` configuration file (see example configuration in ` config.json ` ).
70
- The configuration file must be mounted at ` /app/config.json ` in the backend docker container (see ` docker-compose.prod.yml ` ).
71
- A complete description of the JSON schema can be found in ` src/server/ConfigParser.ts ` .
69
+ The application is configured using a ` .toml ` * or* ` .json ` configuration file (see example configuration in ` config.toml ` ).
70
+ The TOML and JSON format is equivalent, but the ` config.toml ` file takes precedence over the ` config.json ` file.
71
+ The configuration file must be mounted at ` /app/config.toml ` in the backend docker container (see ` docker-compose.prod.yml ` ).
72
+ A complete description of the TOML/JSON schema can be found in ` src/server/ConfigParser.ts ` .
72
73
73
74
** ` .output_path ` **
74
75
- description: Path to the directory storing the temporary DASH media files.
@@ -124,6 +125,8 @@ A complete description of the JSON schema can be found in `src/server/ConfigPars
124
125
125
126
#### Connection Strings
126
127
- Format: [ protocol ` :// ` ] [ username [ ` : ` password] ` @ ` ] hostname [ ` : ` port] [ ` / ` path] [ ` ? ` query]
128
+ - Notes
129
+ - As usual, the username, password, path and query components must be URI encoded (e.g. ` encodeURIComponent("secret password") -> "secret%20password" ` )
127
130
- Examples
128
131
- ` mydomain.com `
129
132
0 commit comments