Take control over your live stream video by running it yourself. Streaming + chat out of the box.
Find a file
2021-10-21 16:36:13 +00:00
.github Replace pkger with go:embed for bundling the admin. Closes #844 (#1464) 2021-10-11 14:56:00 -07:00
.vscode 0.0.6 -> Master (#731) 2021-02-18 23:05:52 -08:00
build Commit updated Javascript packages 2021-10-21 16:36:13 +00:00
config Version constant bump 2021-10-08 21:00:29 -07:00
controllers strip any leading hash symbols from admin tag input using strings.TrimLeft 2021-10-19 16:28:56 +02:00
core refactor geoip (#1442) 2021-10-12 13:21:37 -07:00
doc Commit updated API documentation 2021-09-29 23:37:09 +00:00
examples Banjo/owncast systemd service (#749) 2021-02-21 11:04:20 -08:00
geoip refactor geoip (#1442) 2021-10-12 13:21:37 -07:00
logging Expanded linting + fix warnings (#1396) 2021-09-12 00:18:15 -07:00
metrics Expanded linting + fix warnings (#1396) 2021-09-12 00:18:15 -07:00
models Expanded linting + fix warnings (#1396) 2021-09-12 00:18:15 -07:00
router Use webroot config value 2021-10-12 12:48:10 -07:00
static Update admin 2021-10-13 19:53:10 -07:00
test Fix path to geoip db after test paths were changed 2021-10-12 12:48:10 -07:00
utils fix insecure math/rand use for access token generation (#1441) 2021-10-01 12:46:42 -07:00
webroot Commit updated Javascript packages 2021-10-21 16:36:13 +00:00
yp Expanded linting + fix warnings (#1396) 2021-09-12 00:18:15 -07:00
.editorconfig add starter editorconfig file 2020-08-09 23:44:04 -07:00
.gitattributes Fix paths to fix linguist 2021-10-20 13:14:24 -07:00
.gitignore Automated browser testing (#1415) 2021-09-17 14:04:09 -07:00
.golangci.yml Expanded linting + fix warnings (#1396) 2021-09-12 00:18:15 -07:00
.prettierignore Format javascript on push 2021-02-05 13:10:52 -08:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2020-07-08 17:08:28 -07:00
CONTRIBUTING.md Create CONTRIBUTING.md (#1394) 2021-09-10 12:36:42 -07:00
Dockerfile Fix Dockerfile to be read in Plesk (#1463) 2021-10-12 11:31:58 -07:00
go.mod Bump github.com/yuin/goldmark from 1.4.1 to 1.4.2 (#1486) 2021-10-21 09:33:26 -07:00
go.sum Bump github.com/yuin/goldmark from 1.4.1 to 1.4.2 (#1486) 2021-10-21 09:33:26 -07:00
LICENSE Create LICENSE 2020-07-08 17:07:09 -07:00
main.go Replace pkger with go:embed for bundling the admin. Closes #844 (#1464) 2021-10-11 14:56:00 -07:00
openapi.yaml Bump dev version number 2021-09-29 16:36:30 -07:00
pkged.go Replace pkger with go:embed for bundling the admin. Closes #844 (#1464) 2021-10-11 14:56:00 -07:00
README.md Fix FAQ link 2021-10-13 13:22:58 +02: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

Owncast is an open source, self-hosted, decentralized, single user live video streaming and chat server for running your own live streams similar in style to the large mainstream options. It offers complete ownership over your content, interface, moderation and audience. Visit the demo for an example.


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.

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.

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. go run main.go will run from source.
  5. Point your broadcasting software at your new server and start streaming.

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

Bundling in latest admin from source

The admin ui is built at: https://github.com/owncast/owncast-admin it is bundled into the final binary using pkger.

To bundle in the latest admin UI:

  1. From the owncast directory run the packager script: ./build/admin/bundleAdmin.sh
  2. Compile or run like above. go run main.go

Contributing

Owncast is a growing open source project that is giving freedom, flexibility and fun to live streamers. And while we have a small team of kind, talented and thoughtful volunteers, we have gaps in our skillset that wed love to fill so we can get even better at building tools that make a difference for people.

We abide by our Code of Conduct and feel strongly about open, appreciative, and empathetic people joining us. Weve been very lucky to have this so far, so maybe you can help us with your skills and passion, too!

There is a larger, more detailed, and more up-to-date guide for helping contribute to Owncast on our website.

Architecture

Owncast consists of two repositories with two standalone projects. The repo you're looking at now is the core repository with the backend and frontend. owncast/owncast-admin is an additional web project that is built separately and used for configuration and management of an Owncast server.

Suggestions when working with the Owncast codebase

  1. Install golangci-lint for helpful warnings and suggestions directly in your editor when writing Go.
  2. If using VSCode install the lit-html extension to aid in syntax highlighting of our frontend HTML + Preact.
  3. Run the project with go run main.go.

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