Update documentation since people might try and run this soon
This commit is contained in:
Gabe Kangas
@@ -4,6 +4,5 @@
|
||||
## Table of Contents
|
||||
|
||||
* [Quickstart](quickstart.md)
|
||||
* [Installing](installing.md)
|
||||
* [Configuration](configuration.md)
|
||||
* [S3 Storage](S3.md)
|
||||
@@ -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.
|
||||
@@ -1,4 +0,0 @@
|
||||
Transcoding is done with ffmpeg and that is the one dependency this project requires. So make sure it exists.
|
||||
|
||||
* Download from https://www.johnvansickle.com/ffmpeg/ and point your config file at it if needed.
|
||||
* You will need a somewhat recent version of ffmpeg (TODO: figure out what exact version).
|
||||
@@ -1,27 +1,40 @@
|
||||
## Quickstart
|
||||
|
||||
These steps will utilize Docker, as going from a brand new sever to running the service is easiest done within a container.
|
||||
There are two quick ways to get up and running, depending on your preference. One is to simply download the service and run it, and the other is through Docker, if Docker is your thing.
|
||||
|
||||
1. Create or login to an existing server somewhere.
|
||||
|
||||
### Download
|
||||
1. [Install Docker](https://docs.docker.com/get-docker/). If it's a Debian based linux machine `sudo apt-get install docker.io`.
|
||||
1. [Install git](https://git-scm.com/downloads) `sudo apt-get install git`.
|
||||
## Download and run
|
||||
1. Install [`ffmpeg`](https://ffmpeg.org/download.html) if you haven't.
|
||||
1. Make a directory to run the service from, and download a release from https://github.com/gabek/owncast/releases into that directory.
|
||||
1. Unzip the release's archive: `unzip owncast-linux-x.x.x.zip`.
|
||||
1. [Edit `config.yaml` as detailed below](#configure). Specifically your stream key and `ffmpeg` location.
|
||||
1. Run `./owncast` to start the service.
|
||||
|
||||
---
|
||||
|
||||
or.....
|
||||
|
||||
## Through docker
|
||||
|
||||
1. Download the code. `git clone https://github.com/gabek/owncast`
|
||||
|
||||
### Configure
|
||||
1. Copy `config/config-example.yaml` to `config/config.yaml`
|
||||
1. Edit `config/config.yaml` and change the path of ffmpeg to `/usr/bin/ffmpeg`.
|
||||
1. Copy `config-example.yaml` to `config/config.yaml`
|
||||
1. [Edit `config.yaml`](#configure) and change the path of ffmpeg to `/usr/bin/ffmpeg`.
|
||||
1. Edit your stream key to whatever you'd like it to be in the config.
|
||||
1. Make any other config changes.
|
||||
1. If you ever make any future config file changes you must rerun the `docker build` step otherwise you can just run the `docker run` step to run the service going forward.
|
||||
1. Run `docker build -t owncast .` and wait. It may take a few minutes to build depending on the speed of your server.
|
||||
|
||||
### Run!
|
||||
1. Run `docker run -p 8080:8080 -p 1935:1935 -it owncast` to start the service.
|
||||
|
||||
## That's it!
|
||||
---
|
||||
|
||||
### Configure
|
||||
|
||||
1. Edit `config.yaml` and change the path of ffmpeg to where your copy is.
|
||||
1. In this default configuration there will be a single video quality available, simply whatever is being sent to the server is being distributed to the viewers. The video is also going to be distributed from the server running the service in this case.
|
||||
1. Continue to edit the config file and customize with your own details, links and info. See [More Configuration](configuration.md) to find additional ways to configure video quality.
|
||||
|
||||
### Test
|
||||
1. Point your broadcasting software at your new server using `rtmp://yourserver/live` and the stream key you set above and start your stream.
|
||||
1. Access your server in your web browser by visiting `http://yourserver:8080`.
|
||||
1. If you ever make any future config file changes you must rerun the `docker build` step otherwise you can just run the `docker run` step to run the service going forward.
|
||||
|
||||
|
||||
### That's it!
|
||||
Reference in New Issue
Block a user