Take control over your live stream video by running it yourself. Streaming + chat out of the box.
 
 
 
 
 
 
Gabe Kangas 68414445c2
Add support for changing user color in name modal. Closes #1805
3 years ago
.github Merge branch 'develop' into webv2 3 years ago
.vscode Add support for IP-based bans (#1703) 3 years ago
activitypub Merge branch 'develop' into webv2 3 years ago
auth Fix creating table indexes 3 years ago
build Lock file maintenance 3 years ago
config Add support for changing user color in name modal. Closes #1805 3 years ago
controllers Add support for changing user color in name modal. Closes #1805 3 years ago
core Add support for changing user color in name modal. Closes #1805 3 years ago
db Add support for changing user color in name modal. Closes #1805 3 years ago
docs Commit updated API documentation 3 years ago
examples Remove overly complex and specific docker-compose examples. Closes #1475 4 years ago
geoip refactor geoip (#1442) 4 years ago
logging Expanded linting + fix warnings (#1396) 4 years ago
metrics Fix up the wasted CPU transcoding alert message 3 years ago
models ../ 3 years ago
notifications Fix creating table indexes 3 years ago
router Set ReadHeaderTimeout in http server 3 years ago
static Merge branch 'develop' into webv2 3 years ago
test Merge branch 'develop' into webv2 3 years ago
utils Add support for changing user color in name modal. Closes #1805 3 years ago
web Add support for changing user color in name modal. Closes #1805 3 years ago
webroot Merge remote-tracking branch 'origin/develop' into webv2 3 years ago
yp refactor: move from io/ioutil to io and os packages (#1546) 4 years ago
.editorconfig Update EditorConfig with some explicit settings 3 years ago
.gitattributes doc -> docs as Github needs a specific name 3 years ago
.gitignore Typo in gitignore 3 years ago
.golangci.yml Explicitly set go version in linter config. 3 years ago
.prettierignore Added moderator menu to messages and some other styling. 3 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 5 years ago
CONTRIBUTING.md Create CONTRIBUTING.md (#1394) 4 years ago
Dockerfile Change CMD to ENTRYPOINT (#1831) 3 years ago
Earthfile Merge branch 'develop' into webv2 3 years ago
LICENSE Create LICENSE 5 years ago
README.md Tweak readme to reference the web project accurately. 3 years ago
go.mod Update module github.com/shirou/gopsutil/v3 to v3.22.7 3 years ago
go.sum Update module github.com/shirou/gopsutil/v3 to v3.22.7 3 years ago
main.go Fix "invalid cross-device link" error when running on a different filesystem (#1769) 3 years ago
openapi.yaml Merge remote-tracking branch 'origin/develop' into webv2 3 years ago
renovate.json Remove schedule from renovate 3 years ago
sqlc.yaml Messages table fixes to improve query performance (#2026) 3 years 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

Owncast consists of two projects.

  1. The Owncast backend written in Go.
  2. The frontend written in React.

Read more about running from source.

Backend

The Owncast backend is a service written in Go.

  1. Ensure you have a c 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.

Frontend

The frontend is the web interface that includes the player, chat, embed components, and other UI.

  1. This project lives in the web directory.
  2. Run npm install to install the Javascript dependencies.
  3. Run npm run dev

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.

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@social.gabekangas.com - email gabek@real-ity.com

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