ynerant/ghostream
1
0
Fork 0
mirror of https://gitlab.crans.org/nounous/ghostream.git synced 2024-12-22 15:02:19 +00:00
Code Issues Releases Wiki Activity

Add note about conf via env vars

Browse Source
This commit is contained in:
Alexandre Iooss 2020-10-09 17:37:32 +02:00
parent 22192a5f68
commit 99bfc5e109
No known key found for this signature in database
GPG Key ID: 6C79278F3FCDCC02
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -36,6 +36,11 @@ docker build . -t ghostream
docker run -it --rm -p 2112:2112 -p 9710:9710/udp -p 8080:8080 -p 10000-10005:10000-10005/udp ghostream docker run -it --rm -p 2112:2112 -p 9710:9710/udp -p 8080:8080 -p 10000-10005:10000-10005/udp ghostream
``` ```
## Configuration
Ghostream can be configured by placing [ghostream.yml](docs/ghostream.example.yml) in current directory, in `~/.ghostream/` or in `/etc/ghostream/`.
You can also override any value using environnement variables, e.g. `GHOSTREAM_AUTH_BACKEND=ldap` will change the authentification backend.
## Streaming ## Streaming
As stated by OBS wiki, when streaming you should adapt the latency to `2.5 * (the round-trip time with server, in μs)`. As stated by OBS wiki, when streaming you should adapt the latency to `2.5 * (the round-trip time with server, in μs)`.

3
docs/ghostream.example.yml
View File

@ -1,5 +1,8 @@
## Example Ghostream configuration ## ## Example Ghostream configuration ##
# Uncomment and edit to change values # Uncomment and edit to change values
#
# All settings can also be changed with an environnement variable,
# e.g. GHOSTREAM_AUTH_BACKEND=ldap will change auth.backend to "ldap"
## Authentification package ## ## Authentification package ##
# Manage incoming stream authentification # Manage incoming stream authentification