Take control over your live stream video by running it yourself. Streaming + chat out of the box.
Find a file
2020-11-28 15:34:40 -08:00
.github End to end automated tests run on Github workflows (#384) 2020-11-24 00:28:54 -08:00
.vscode Fix typo in verbose launch args 2020-10-24 16:01:49 -07:00
build Bump @joeattardi/emoji-button from 4.5.0 to 4.5.1 in /build/javascript (#395) 2020-11-24 00:28:25 -08:00
config Make things not break if video passthrough is enabled + update admin to display video settings a bit clearer. A start to #306 2020-11-19 22:12:48 -08:00
controllers Make things not break if video passthrough is enabled + update admin to display video settings a bit clearer. A start to #306 2020-11-19 22:12:48 -08:00
core Fix blocking YP 2020-11-20 22:59:20 -08:00
data Render and sanitize chat messages server-side. (#237) 2020-10-13 16:45:52 -07:00
doc/api Commit updated API documentation 2020-11-17 23:13:26 +00:00
examples Put example compose file into examples 2020-11-19 23:33:25 -08:00
geoip Start cleaning up linter errors. (#358) 2020-11-14 18:39:53 -08:00
logging Fix godoc style comments (#356) 2020-11-12 15:14:59 -08:00
metrics Increase how often viewer counts are collected. Closes #392 2020-11-23 22:21:20 -08:00
models Support framerate to be a float. For #378 2020-11-17 21:21:19 -08:00
router Start cleaning up linter errors. (#358) 2020-11-14 18:39:53 -08:00
static [ImgBot] Optimize images (#313) 2020-10-31 13:27:39 -07:00
test End to end automated tests run on Github workflows (#384) 2020-11-24 00:28:54 -08:00
utils Tame down encoding performance alerts. Closes #338 2020-11-16 21:02:48 -08:00
webroot Connect to websocket in embed player. Closes #361 2020-11-20 18:06:51 -08:00
yp Simplify Logo requirement from users. (#373) 2020-11-17 15:12:54 -08:00
.editorconfig add starter editorconfig file 2020-08-09 23:44:04 -07:00
.gitattributes Add attributes file 2020-10-05 23:16:11 -07:00
.gitignore Bundle and serve admin (#317) 2020-11-06 15:12:35 -08:00
.golangci.yml Use a golangci-lint workflow to check for common mistakes & problems (#353) 2020-11-12 14:42:39 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-07-08 17:08:28 -07:00
config-default.yaml Make default config file simpler. Closes #364 (#375) 2020-11-19 08:48:33 -08:00
Dockerfile Update the dev dockerfile and build dockerfile to fix #60 2020-07-14 17:51:48 -07:00
go.mod Bump github.com/aws/aws-sdk-go from 1.35.34 to 1.35.35 (#397) 2020-11-25 00:11:04 -08:00
go.sum Bump github.com/aws/aws-sdk-go from 1.35.34 to 1.35.35 (#397) 2020-11-25 00:11:04 -08:00
LICENSE Create LICENSE 2020-07-08 17:07:09 -07:00
main.go Add database schema versioning & migration skeleton (#382) 2020-11-18 16:49:54 -08:00
openapi.yaml Simplify Logo requirement from users. (#373) 2020-11-17 15:12:54 -08:00
pkged.go Update admin bundle 2020-11-28 15:34:40 -08:00
README.md Update readme 2020-11-17 08:24:49 -08:00


Logo

Take control over your content and stream it yourself.
Explore the docs »

View Demo · Use Our Server for Testing · FAQ · Report Bug

Table of Contents

About The Project

In 2020 the world changed when everyone become stuck in their homes, looking for creative outlets to share their art, skills and themselves from inside their bedroom.

This created an explosion of live streaming on Facebook Live, YouTube Live, Instagram, and Twitch. These services provided everything they needed, an easy way to live stream to the world, and a chat for users to be a part of their community.

That's when I wanted a better option for people. Something you could run yourself and get all the functionality of these services, where you could live stream to an audience and and allow them to take part in the chat, just like they've been used to on all the other services. There should be a independent, standalone Twitch in a Box.

Keep in mind that while streaming to the big social companies is always free, you pay for it with your identity and your data, as well as the identity and data of every person that tunes in. When you self-host anything you'll have to pay with your money instead. But running a self-hosted live stream server can be done for as cheap as $5/mo, and that's a much better deal than selling your soul to Facebook, Google or Amazon.


Getting Started

The goal is to have a single service that you can run and it works out of the box. Visit the Quickstart to get up and running.

Configuration

Many aspects can be adjusted and customized to your preferences. Read more about Configuration to update the web UI, video settings, and more.

Web interface + chat

Owncast includes a web interface to your video with built-in chat that is available once you start the server.

The web interface was specifically built to be editable by anybody comfortable tweaking a web page. It's not bundled or transpiled into anything, it's just HTML + Javascript + CSS that you can start editing.

Read more about the features provided and how to configure them in the web documentation.

Use with your existing broadcasting software

In general Owncast is compatible with any software that uses RTMP to broadcast to a remote server. RTMP is what all the major live streaming services use, so if youre currently using one of those its likely that you can point your existing software at your Owncast instance instead.

OBS, Streamlabs, Restream and many others have been used with Owncast. Read more about compatibility with existing software.

Video storage options

Two ways of storing and distributing the video are supported.

  1. Locally via the built-in web server.
  2. S3-compatible storage.

Local file distribution

This is the simplest and works out of the box. In this scenario video will be served to the public from the computer that is running the server. If you have a fast internet connection, enough bandwidth alotted to you, and a small audience this may be fine for many people.

S3-Compatible Storage

Instead of serving video directly from your personal server you can use a S3 compatible storage provider to offload the bandwidth and storage requirements elsewhere.

Read more detailed documentation about configuration of S3-compatible services.

Building from Source

  1. Ensure you have the gcc compiler configured.
  2. Install the Go toolchain.
  3. Clone the repo. git clone https://github.com/owncast/owncast
  4. Follow the above Getting Started instructions, making sure ffmpeg exists and your config file is set.
  5. go run main.go pkged.go on the first run will download the required packages needed for the application to build.
  6. It will start running the same as in the above Usage instructions and you can point OBS to your localhost instance of it.

There is also a supplied Dockerfile so you can spin it up from source with little effort. Read more about running from source.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project chat: Join us on Rocket.Chat if you want to contribute, follow along, or if you have questions.

Gabe Kangas - @gabek@mastodon.social - email gabek@real-ity.com

Project Link: https://github.com/owncast/owncast