owncast/doc/quickstart.md

Quickstart

These steps will utilize Docker, as going from a brand new sever to running the service is easiest done within a container.

1. Create or login to an existing server somewhere.

Download

1. Install Docker. If it's a Debian based linux machine sudo apt-get install docker.io.
2. Install git sudo apt-get install git.
3. Download the code. git clone https://github.com/gabek/owncast

Configure

1. Copy config/config-example.yaml to config/config.yaml
2. Edit config/config.yaml and change the path of ffmpeg to /usr/bin/ffmpeg.
3. Edit your stream key to whatever you'd like it to be in the config.
4. Make any other config changes.
5. 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!

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.
2. Access your server in your web browser by visiting http://yourserver:8080.
3. 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.