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.
 
 
 
 
 
 
Go to file
Owncast dae199d33d
Bundle embedded web app
6 hours ago
.design chore(docs): update docs to reflect font change 11 months ago
.github chore(deps): update peter-evans/create-or-update-comment digest to 5e08535 1 week ago
.vscode chore: remove vscode config file 9 months ago
activitypub chore(test): support followers fixture data for testing 1 month ago
auth fix: add additional validation before making remote requests (#3398) 5 months ago
build fix(deps): update nextjs monorepo to v14 (major) (#3404) 4 months ago
config chore: reverting the current implementation of http response caching 3 months ago
contrib chore(go): bump project version number to 1.21 5 months ago
controllers set content-type for customjavascript (#3612) 3 weeks ago
core fix(chat): do not send chat join message 1 month ago
db Check if proposed name change is an API name (#3256) 8 months ago
docs fix(deps): update module mvdan.cc/xurls to v2 (#3369) 5 months ago
geoip chore(go): run betteralign and gofumpt on codebase 6 months ago
logging chore(go): run betteralign and gofumpt on codebase 6 months ago
metrics chore(go): run betteralign and gofumpt on codebase 6 months ago
models fix(webhooks): fix chat user parted webhook creation error. Closes #3524 1 month ago
notifications Guard against invalid push server response as an addition check for #2855 1 year ago
router chore: reverting the current implementation of http response caching 3 months ago
static Bundle embedded web app 6 hours ago
test Bump follow-redirects from 1.15.4 to 1.15.6 in /test/load (#3632) 4 days ago
utils Refactored the GetIpddressFromRequest function to support ipv4 as well as ipv6 addresses (#3496) 3 months ago
web Commit updated Storybook stories 6 hours ago
yp chore(go): run betteralign and gofumpt on codebase 6 months ago
.editorconfig Update EditorConfig with some explicit settings 2 years ago
.gitattributes Update gitattributes file 1 year ago
.gitignore chore: add support for exporting our colors as Swift files 9 months ago
.gitpod.yml Add Gitpod config (#2173) 2 years ago
.golangci.yml chore(go): bump project version number to 1.21 5 months ago
.prettierignore Added moderator menu to messages and some other styling. 2 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 4 years ago
CONTRIBUTING.md Create CONTRIBUTING.md (#1394) 3 years ago
Dockerfile chore(deps): update alpine docker tag to v3.19.1 2 months ago
Earthfile fix: export correct timestamps on build artifacts. Closes #3282 7 months ago
LICENSE Update LICENSE to be current (#3058) 10 months ago
README.md Update links to docker image in readme 5 months ago
go.mod Bump google.golang.org/protobuf from 1.32.0 to 1.33.0 (#3629) 4 days ago
go.sum Bump google.golang.org/protobuf from 1.32.0 to 1.33.0 (#3629) 4 days ago
main.go chore: reverting the current implementation of http response caching 3 months ago
openapi.yaml fix /api/admin/config/streamkeys docs (#3409) 5 months ago
renovate.json Remove references to webv2 branch in docs and builds 1 year ago
sqlc.yaml Messages table fixes to improve query performance (#2026) 2 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 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

Owncast consists of two projects.

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

Read more about running from source.

Important note about source code and the develop branch

The develop branch is always the most up-to-date state of development and this may not be what you always want. If you want to run the latest released stable version, check out the tag related to that release. For example, if you'd only like the source prior to the v0.1.0 development cycle you can check out the v0.0.13 tag.

Note: Currently Owncast does not natively support Windows servers. However, Windows Users can use Windows Subsystem for Linux (WSL2) to install Owncast. For details visit this document.

Backend

The Owncast backend is a service written in Go.

  1. Ensure you have prerequisites installed.
  2. Install the Go toolchain (1.21 or above).
  3. Clone the repo. git clone https://github.com/owncast/owncast
  4. go run main.go will run from the 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 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.

License

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

Supported by

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