owncast/config-example.yaml

# See https://owncast.online/docs/configuration/ for more details

instanceDetails:
  name: Owncast
  title: Owncast
  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."

  logo: /img/logo.svg

  tags:
    - music
    - software
    - streaming

  nsfw: false

  # https://owncast.online/docs/configuration/#external-links
  # for full list of supported social links.  All optional.
  socialHandles:
    - platform: github
      url: http://github.com/owncast/owncast
    - platform: mastodon
      url: http://mastodon.something/owncast

videoSettings:
  # Change this value and keep it secure.  Treat it like a password to your live stream.
  streamingKey: abc123

  streamQualities:
    - low:
      videoBitrate: 800
      scaledWidth: 640
      encoderPreset: veryfast

    - medium:
      videoBitrate: 1200
      encoderPreset: veryfast

    - high:
      videoBitrate: 1600
      encoderPreset: veryfast

# Set to true if you don't want the service checking for future releases.
disableUpgradeChecks: false
Update default config file 2020-09-22 10:12:56 +02:00			`# See https://owncast.online/docs/configuration/ for more details`

Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00			`instanceDetails:`
			`name: Owncast`
Update default config file 2020-09-22 10:12:56 +02:00			`title: Owncast`
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."`
Update default config file 2020-09-22 10:12:56 +02:00
Simplify Logo requirement from users. (#373) * Simplify Logo requirement from users. - Only require 1 logo file, instead of a `small` and `large` one. Just require `logo`. - Update frontend sso that primary header logo will ALWAYS be owncast logo. - User's logo will remain in "user content" area. * Commit updated API documentation Co-authored-by: Owncast <owncast@owncast.online> 2020-11-18 00:12:54 +01:00			`logo: /img/logo.svg`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00
			`tags:`
			`- music`
			`- software`
Update default config file 2020-09-22 10:12:56 +02:00			`- streaming`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00
Extended config example (#363) 2020-11-15 20:58:48 +01:00			`nsfw: false`

Update default config file 2020-09-22 10:12:56 +02:00			`# https://owncast.online/docs/configuration/#external-links`
Remove extra items in config to continue to simplify 2020-07-14 00:04:53 +02:00			`# for full list of supported social links. All optional.`
Consolidate config files and surface frontend values via API. Closes #30 2020-06-29 00:10:00 +02:00			`socialHandles:`
Update default config file 2020-09-22 10:12:56 +02:00			`- platform: github`
			`url: http://github.com/owncast/owncast`
			`- platform: mastodon`
			`url: http://mastodon.something/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:`
Remove extra items in config to continue to simplify 2020-07-14 00:04:53 +02:00			`# Change this value and keep it secure. Treat it like a password to your live stream.`
Reject invalid streaming key 2020-06-02 02:15:11 +02:00			`streamingKey: abc123`
First pass at YP registration/configuration (#209) * Spike: Ping YP service with instance details * WIP: Add to the config to support YP * Add YP response endpoint * Handle YP errors. Use config. Off by default * Show message about YP support on launch * Add animated gif preview when generating thumb * Increase quality of preview gif and only create it if YP is enabled * Do not allow re-registration by clearing the key * Make large and small logos actually structured * Change log level * Fix default YP service URL * Point to default hostname * Set default value for YP to false 2020-10-02 08:55:38 +02:00
Extended config example (#363) 2020-11-15 20:58:48 +01:00			`streamQualities:`
			`- low:`
			`videoBitrate: 800`
			`scaledWidth: 640`
			`encoderPreset: veryfast`

			`- medium:`
			`videoBitrate: 1200`
			`encoderPreset: veryfast`

			`- high:`
			`videoBitrate: 1600`
			`encoderPreset: veryfast`

Replace admin broadcaster with status api 2020-11-06 03:29:16 +01:00			`# Set to true if you don't want the service checking for future releases.`
			`disableUpgradeChecks: false`