#sqt fork: Take control over your live stream video by running it yourself. Streaming + chat out of the box.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
GNU+ullard e5b8547569 Bump VERSION with sqt suffix 3 months ago
.github Update stale PR message 6 months ago
.vscode Auto updater APIs (#1523) 7 months ago
activitypub Remove unnecessary var data in log messages. Closes #1640 4 months ago
build Explicitly set go version 4 months ago
config Bump VERSION with sqt suffix 3 months ago
controllers Remove unused var 4 months ago
core change hard coded 5 minute freeze chat value to 60 minute 3 months ago
db Order followers 5 months ago
doc Commit updated API documentation 5 months ago
examples Remove overly complex and specific docker-compose examples. Closes #1475 8 months ago
geoip refactor geoip (#1442) 9 months ago
logging Expanded linting + fix warnings (#1396) 10 months ago
metrics Expanded linting + fix warnings (#1396) 10 months ago
models Social features / ActivityPub federation (#1629) 6 months ago
router Remove unnecessary var data in log messages. Closes #1640 4 months ago
static Update admin to 783b5693e63795d2d381cff2b1b062c24b2cbd52 4 months ago
test Bump follow-redirects from 1.14.4 to 1.14.8 in /test/automated/browser (#1735) 4 months ago
utils Remove references to config file. #1697 5 months ago
webroot Correct math for 1 hour's chat after offline 3 months ago
yp refactor: move from io/ioutil to io and os packages (#1546) 7 months ago
.editorconfig add starter editorconfig file 2 years ago
.gitattributes Fix paths to fix linguist 8 months ago
.gitignore Automated browser testing (#1415) 9 months ago
.golangci.yml I should probably just remove the dupl linter 6 months ago
.prettierignore Format javascript on push 1 year ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2 years ago
CONTRIBUTING.md Create CONTRIBUTING.md (#1394) 10 months ago
Dockerfile Fix Dockerfile to be read in Plesk (#1463) 9 months ago
LICENSE Create LICENSE 2 years ago
README.md Tweak readme source instructions 6 months ago
go.mod Bump github.com/yuin/goldmark from 1.4.6 to 1.4.7 (#1742) 4 months ago
go.sum Bump github.com/yuin/goldmark from 1.4.6 to 1.4.7 (#1742) 4 months ago
main.go Do not log stream key when changing it 5 months ago
openapi.yaml Update API spec for 0.0.11. Closes #1666 5 months ago
sqlc.json Social features / ActivityPub federation (#1629) 6 months ago

README.md


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 you’re currently using one of those it’s 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 installed.
  2. Install the Go toolchain (1.16 or above).
  3. Clone the repo. git clone https://github.com/owncast/owncast
  4. go run main.go will run from source.
  5. Visit http://yourserver:8080 to access the web interface or http://yourserver:8080/admin to access the admin.
  6. 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 we’d 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. We’ve 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