owncast/config-example.yaml

publicHLSPath: webroot/hls
privateHLSPath: hls
ffmpegPath: /usr/bin/ffmpeg
webServerPort: 8080

instanceDetails:
  name: Owncast
  title: Owncast Demo Server
  summary: "This is brief summary of whom you are or what your stream is. You can read more about it at owncast.online.  You can edit this description in your config file."
  extraUserInfoFileName: "/static/content.md"
  
  logo:
    small: /img/logo128.png
    large: /img/logo128.png

  tags:
    - music
    - software
    - animal crossing

  # See documentation for full list of supported social links.  All optional.
  socialHandles:
    - platform: twitter
      url: http://twitter.com/owncast
    - platform: instagram
      url: http://instagram.biz/owncast
    - platform: facebook
      url: http://facebook.gov/owncast
    - platform: tiktok
      url: http://tiktok.cn/owncast
    - platform: soundcloud
      url: http://soundcloud.com/owncast

videoSettings:
  chunkLengthInSeconds: 4
  streamingKey: abc123
  offlineContent: static/offline.m4v # Is displayed when a stream ends

  streamQualities:
    # Transcode the video to a lower bitrate and resize
    - medium:
    videoBitrate: 800
    encoderPreset: superfast

files:
  maxNumberInPlaylist: 30

ipfs:
  enabled: false
  gateway: https://ipfs.io

s3:
  enabled: false
  endpoint: https://s3.us-west-2.amazonaws.com
  accessKey: ABC12342069
  secret: lolomgqwtf49583949
  region: us-west-2
  bucket: myvideo
Add config file. Turn on/off ipfs 2020-06-02 01:53:31 +02:00			`publicHLSPath: webroot/hls`
			`privateHLSPath: hls`
New video transcoder (#27) * New video transcoder * Set a smaller max muxing size + logging tweaks * No need to return an err since it wiill panic anyway * Use a default encoder preset if one is not supplied * Rename to NewTranscoder. Add comments. * Rename Bitrate to VideoBitrate. Config file changes required with this rename. * Allow overrides of segment length. Allow offline stream to live in a single segment * Append offline state video to existin HLS stream instead of overwriting because players do not like that * Make properties private as they do not need to be exported 2020-06-26 02:44:47 +02:00			`ffmpegPath: /usr/bin/ffmpeg`
Add config file. Turn on/off ipfs 2020-06-02 01:53:31 +02:00			`webServerPort: 8080`

Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00			`instanceDetails:`
			`name: Owncast`
			`title: Owncast Demo Server`
Move around how SocialHandles are configured. Closes #30 2020-07-01 02:11:24 +02:00			`summary: "This is brief summary of whom you are or what your stream is. You can read more about it at owncast.online. You can edit this description in your config file."`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00			`extraUserInfoFileName: "/static/content.md"`
Support a map of logos for #30 2020-06-29 00:13:01 +02:00
			`logo:`
			`small: /img/logo128.png`
			`large: /img/logo128.png`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00
			`tags:`
			`- music`
			`- software`
			`- animal crossing`

			`# See documentation for full list of supported social links. All optional.`
			`socialHandles:`
Move around how SocialHandles are configured. Closes #30 2020-07-01 02:11:24 +02:00			`- platform: twitter`
			`url: http://twitter.com/owncast`
			`- platform: instagram`
			`url: http://instagram.biz/owncast`
			`- platform: facebook`
			`url: http://facebook.gov/owncast`
			`- platform: tiktok`
			`url: http://tiktok.cn/owncast`
			`- platform: soundcloud`
			`url: http://soundcloud.com/owncast`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00
Add config file. Turn on/off ipfs 2020-06-02 01:53:31 +02:00			`videoSettings:`
			`chunkLengthInSeconds: 4`
Reject invalid streaming key 2020-06-02 02:15:11 +02:00			`streamingKey: abc123`
New video transcoder (#27) * New video transcoder * Set a smaller max muxing size + logging tweaks * No need to return an err since it wiill panic anyway * Use a default encoder preset if one is not supplied * Rename to NewTranscoder. Add comments. * Rename Bitrate to VideoBitrate. Config file changes required with this rename. * Allow overrides of segment length. Allow offline stream to live in a single segment * Append offline state video to existin HLS stream instead of overwriting because players do not like that * Make properties private as they do not need to be exported 2020-06-26 02:44:47 +02:00			`offlineContent: static/offline.m4v # Is displayed when a stream ends`
Add config file. Turn on/off ipfs 2020-06-02 01:53:31 +02:00
Support multiple adaptive bitrates 2020-06-09 10:52:15 +02:00			`streamQualities:`
New video transcoder (#27) * New video transcoder * Set a smaller max muxing size + logging tweaks * No need to return an err since it wiill panic anyway * Use a default encoder preset if one is not supplied * Rename to NewTranscoder. Add comments. * Rename Bitrate to VideoBitrate. Config file changes required with this rename. * Allow overrides of segment length. Allow offline stream to live in a single segment * Append offline state video to existin HLS stream instead of overwriting because players do not like that * Make properties private as they do not need to be exported 2020-06-26 02:44:47 +02:00			`# Transcode the video to a lower bitrate and resize`
Add default video settings if none are provided 2020-07-12 03:31:28 +02:00			`- medium:`
			`videoBitrate: 800`
			`encoderPreset: superfast`
Support multiple adaptive bitrates 2020-06-09 10:52:15 +02:00
Add config file. Turn on/off ipfs 2020-06-02 01:53:31 +02:00			`files:`
			`maxNumberInPlaylist: 30`

			`ipfs:`
Reject invalid streaming key 2020-06-02 02:15:11 +02:00			`enabled: false`
Add support for storing chunks on S3 2020-06-03 10:34:05 +02:00			`gateway: https://ipfs.io`

			`s3:`
			`enabled: false`
Add support for non-AWS S3 storage endpoints and auth 2020-06-09 23:01:42 +02:00			`endpoint: https://s3.us-west-2.amazonaws.com`
Add support for storing chunks on S3 2020-06-03 10:34:05 +02:00			`accessKey: ABC12342069`
			`secret: lolomgqwtf49583949`
			`region: us-west-2`
New video transcoder (#27) * New video transcoder * Set a smaller max muxing size + logging tweaks * No need to return an err since it wiill panic anyway * Use a default encoder preset if one is not supplied * Rename to NewTranscoder. Add comments. * Rename Bitrate to VideoBitrate. Config file changes required with this rename. * Allow overrides of segment length. Allow offline stream to live in a single segment * Append offline state video to existin HLS stream instead of overwriting because players do not like that * Make properties private as they do not need to be exported 2020-06-26 02:44:47 +02:00			`bucket: myvideo`