Skip to content

Commit 517b918

Browse files
authored
docs: add TOML as preferred config lang over JSON
1 parent dc0415b commit 517b918

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,17 +58,18 @@ Commands (PTZ, Pan Tilt Zoom) issued from your browser are forwarded to the Node
5858
## Installation / Getting Started
5959
1. Copy the `docker-compose.prod.yml` template to wherever you want to deploy the application
6060
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
6262
1. Copy the nginx configuration template from `nginx/nginx.conf` and configure to your liking
6363
1. `docker-compose up -d`
6464

6565
### Custom Encoding
6666
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.
6767

6868
### 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`.
7273

7374
**`.output_path`**
7475
- 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
124125

125126
#### Connection Strings
126127
- 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"`)
127130
- Examples
128131
- `mydomain.com`
129132
- `myproto://[email protected]`

0 commit comments

Comments
 (0)