diff --git a/README.md b/README.md index 601658343..3eb133d42 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,9 @@ * [Installation](#installation) * [Usage](#usage) * [Docker](#docker) -* [Usage with OBS](#usage-with-obs) +* [Use with your software](#use-with-your-desktop-software) + * [OBS](#usage-with-obs) + * [Restream](#usage-with-restream) * [Video storage and distribution options](#video-storage-options) * [Advanced usage](#advanced-usage) * [Building from source](#building-from-source) @@ -92,7 +94,9 @@ If you want a simpler way to run an instance of owncast you can run it in a cont 1. Run `docker build -t owncast .` 1. Run `docker run -p 8080:8080 -p 1935:1935 -it owncast` -## Usage with OBS +## Use with your desktop software + +### Usage with OBS 1. Install [OBS](https://obsproject.com/) and get it working with your local setup. 1. Open OBS Settings and go to "Stream". @@ -102,6 +106,10 @@ If you want a simpler way to run an instance of owncast you can run it in a cont 5. Start the server. 6. Press "Start Streaming" on OBS. +### Usage with Restream + +Read the [detailed documentation for working with Restream](https://github.com/gabek/owncast/blob/master/doc/restream.md) + ## Video storage options Three ways of storing and distributing the video are supported. diff --git a/doc/restream.md b/doc/restream.md new file mode 100644 index 000000000..565b0f31b --- /dev/null +++ b/doc/restream.md @@ -0,0 +1,9 @@ +# Restream.io + +If you're a paid user of [Restream](http://restream.io) you can point it at your Ownstream instance as another place to braodcast to. +1. Login and go to the "Add Channel" screen. + +1. Select "Custom RTMP" + +1. Add your server information in the format of `rtmp://myserver/live` for the RTMP URL and the Stream Key that matches what is in your `config.yaml` file. + \ No newline at end of file diff --git a/doc/restream1.png b/doc/restream1.png new file mode 100644 index 000000000..293916f68 Binary files /dev/null and b/doc/restream1.png differ diff --git a/doc/restream2.png b/doc/restream2.png new file mode 100644 index 000000000..980698f29 Binary files /dev/null and b/doc/restream2.png differ diff --git a/doc/restream3.png b/doc/restream3.png new file mode 100644 index 000000000..5341b808b Binary files /dev/null and b/doc/restream3.png differ