ghostream/docs/ghostream.example.yml

137 lines
3.5 KiB
YAML
Raw Normal View History

2020-10-09 15:30:14 +00:00
## Example Ghostream configuration ##
# Uncomment and edit to change values
2020-10-09 15:37:32 +00:00
#
# All settings can also be changed with an environnement variable,
# e.g. GHOSTREAM_AUTH_BACKEND=ldap will change auth.backend to "ldap"
2020-09-22 14:39:06 +00:00
2020-10-09 15:30:14 +00:00
## Authentification package ##
2020-09-22 14:39:06 +00:00
auth:
2020-10-09 20:06:30 +00:00
# If you disable authentification no more check will be done on incoming
# streams.
#
#enabled: true
2020-10-09 15:30:14 +00:00
# Authentification backend,
# can be "basic" to use a list of user:password
# can be "ldap" to use a LDAP server
#
#backend: basic
# Basic backend configuration
#
#basic:
# credentials:
# # Demo user with password "demo"
# demo: $2b$15$LRnG3eIHFlYIguTxZOLH7eHwbQC/vqjnLq6nDFiHSUDKIU.f5/1H6
2020-09-22 14:39:06 +00:00
2020-10-09 15:30:14 +00:00
# LDAP backend configuration
2020-09-29 15:27:19 +00:00
#
2020-09-22 14:39:06 +00:00
#ldap:
# uri: ldap://127.0.0.1:389
# userdn: cn=users,dc=example,dc=com
2020-10-09 15:30:14 +00:00
## Stream forwarding ##
# Forward an incoming stream to other servers
# The URL can be anything FFMpeg can accept as an stream output
2020-09-30 13:07:36 +00:00
forwarding:
2020-10-09 15:30:14 +00:00
# By default nothing is forwarded.
#
# This example forwards a stream named "demo" to Twitch and YouTube,
2020-09-30 13:07:36 +00:00
#demo:
# - rtmp://live-cdg.twitch.tv/app/STREAM_KEY
# - rtmp://a.rtmp.youtube.com/live2/STREAM_KEY
2020-10-09 15:30:14 +00:00
## Prometheus monitoring ##
# Expose a monitoring endpoint for Prometheus
2020-09-22 14:39:06 +00:00
monitoring:
2020-10-09 20:06:30 +00:00
# If you disable monitoring module, no more metrics will be exposed.
#
#enabled: true
2020-10-09 15:30:14 +00:00
# You should not expose monitoring metrics to the whole world.
# To limit access to only localhost, use 127.0.0.1:2112
#listenAddress: :2112
2020-09-22 14:39:06 +00:00
2020-10-09 15:30:14 +00:00
## SRT server ##
# The SRT server receive incoming stream and can also serve video to clients.
srt:
2020-10-09 20:06:30 +00:00
# If you disable SRT module, it will be no more possible to receive incoming
# streams and this whole app will become useless.
#
#enabled: true
2020-10-09 15:30:14 +00:00
# To limit access to only localhost, use 127.0.0.1:9710
#listenAddress: :9710
# Max number of active SRT connections
2020-10-09 15:30:14 +00:00
#maxClients: 64
2020-10-09 15:30:14 +00:00
## Web server ##
# The web server serves a WebRTC player.
2020-09-22 14:39:06 +00:00
web:
2020-10-09 20:06:30 +00:00
# If you disable web module, the stream will be accessible only via SRT or
# via forwarding module (see above).
#
#enabled: true
2020-10-11 09:04:40 +00:00
# Custom CSS stylesheet to change theme
#
#customCss: ""
2020-10-09 15:30:14 +00:00
# Web page favicon, can be .ico, .png or .svg
#
#favicon: /static/img/favicon.svg
# Server name seen by users
# If example.com reverses to this server, then change to example.com
#
#hostname: localhost
# To limit access to only localhost, use 127.0.0.1:8080
#
#listenAddress: :8080
# Web site name
# Put something cool here, such as "Cr@ns Stream"
#
#name: Ghostream
# Use the domain name as the stream name
# e.g., on http://example.com:8080/ the stream served will be "example.com"
# This implies that your domain will be able to serve only one stream.
#
#oneStreamPerDomain: false
# Stream player poster
# Shown when stream is loading or inactive.
#
#playerPoster: /static/img/no_stream.svg
2020-10-09 15:30:14 +00:00
# Refresh period for viewer stats (below the player)
#
#viewersCounterRefreshPeriod: 20000
# Add a web page as a side widget
# This can be a public TheLounge or Element instance to make a chat.
# You can use {{.Path}} to include current stream name,
# e.g. https://example.com/stream_{{.Path}}
#
#widgetURL: ""
## WebRTC server ##
webrtc:
2020-10-09 20:06:30 +00:00
# If you disable webrtc module, the web client won't be able to play streams.
#
#enabled: true
# UDP port range used to stream
2020-10-09 15:30:14 +00:00
# This range must be opened in your firewall.
#
#minPortUDP: 10000
#maxPortUDP: 10005
2020-09-29 15:27:19 +00:00
# STUN servers, you should host your own Coturn instance
2020-10-09 15:30:14 +00:00
#
#STUNServers:
# - stun:stun.l.google.com:19302