Update documentation since people might try and run this soon

This commit is contained in:
Gabe Kangas
2020-06-28 16:19:26 -07:00
parent ae2e98877b
commit 46177b8163
6 changed files with 71 additions and 64 deletions

View File

@@ -1,15 +1,20 @@
# Configuration
## Video Quality
Owncast supports HLS [Adaptive bitrate streaming](https://en.wikipedia.org/wiki/Adaptive_bitrate_streaming), or in other words, different video qualities that can be used for different network conditions.
You can edit the `config/config.yaml` file and add as many stream _variants_ as you like under the `videoSettings` block, like so:
You can edit the `config.yaml` file and add as many stream _variants_ as you like under the `videoSettings` block, like so:
```
streamQualities:
- bitrate: 2000k
- bitrate: 6000k
- low:
bitrate: 700
scaledWidth: 600
encoderPreset: superfast
- medium:
bitrate: 900
```
You must have at least one bitrate specified.
@@ -24,3 +29,27 @@ Each bitrate variant adds significant CPU usage and slows down the overall gener
More stream quality variants requires more disk space, since it's another copy of the video on disk. If you're serving video locally and you have enough disk space then it's probably no big deal and files will rather quickly get rotated and cleaned up. If you're using something like [S3 for storage](S3.md) then files won't get cleaned up until some point in the future, so you'll have more remote storage use in play.
## Customization
Editing `config.yaml` allows you to change the name, description, logo and links to external sites.
`socialHandles` currently supports the following services by name:
* `facebook`
* `twitter`
* `instagram`
* `snapchat`
* `tiktok`
* `soundcloud`
* `bandcamp`
* `patreon`
* `youtube`
* `spotify`
* `twitch`
* `paypal`
* `github`
* `linkedin`
* `discord`
* `mastadon`
Update your `tags` in the config to display the topics type of content you want to call attention to.