Take control over your live stream video by running it yourself. Streaming + chat out of the box.
Go to file
2024-07-18 04:11:23 +00:00
.design Update DESIGN.md (#3755) 2024-05-31 08:10:46 -07:00
.github chore(deps): update peter-evans/create-or-update-comment digest to 3496b39 2024-07-17 08:26:58 +00:00
.vscode chore: remove vscode config file 2023-06-22 09:46:45 -07:00
activitypub Spec-based API (#3653) 2024-05-01 19:22:27 -07:00
auth User repository (#3795) 2024-07-01 18:58:50 -07:00
build chore(api): reorganize web assets and codegen types+handlers 2024-07-01 20:14:17 -07:00
config Bump version number 2024-04-09 18:56:31 -07:00
contrib chore(go): bump project version number to 1.21 2023-10-17 18:33:05 -07:00
core fix(deps): update module mvdan.cc/xurls to v2 (#3815) 2024-07-08 11:24:48 -07:00
db Check if proposed name change is an API name (#3256) 2023-08-13 08:57:20 -07:00
docs chore(docs): add redocly config file 2024-07-02 14:22:04 -07:00
logging chore(go): run betteralign and gofumpt on codebase 2023-10-08 14:22:28 -07:00
metrics User repository (#3795) 2024-07-01 18:58:50 -07:00
models chore: move geoip into services directory 2024-07-02 21:26:43 -07:00
notifications User repository (#3795) 2024-07-01 18:58:50 -07:00
persistence User repository (#3795) 2024-07-01 18:58:50 -07:00
services/geoip chore: move geoip into services directory 2024-07-02 21:26:43 -07:00
static Bundle embedded web app 2024-07-16 23:49:33 +00:00
test Bump @grpc/grpc-js from 1.10.6 to 1.10.11 in /test/load (#3833) 2024-07-11 12:22:42 -07:00
utils fix(deps): update module mvdan.cc/xurls to v2 (#3815) 2024-07-08 11:24:48 -07:00
web Commit screenshots 2024-07-18 04:11:23 +00:00
webserver chore(api): move more types to generated ones 2024-07-02 20:37:58 -07:00
yp chore(go): run betteralign and gofumpt on codebase 2023-10-08 14:22:28 -07:00
.editorconfig Update EditorConfig with some explicit settings 2022-07-21 00:13:25 -07:00
.gitattributes Update gitattributes file 2023-01-30 23:24:40 -08:00
.gitignore chore: add support for exporting our colors as Swift files 2023-07-09 12:43:04 -07:00
.gitpod.yml Add Gitpod config (#2173) 2022-10-05 15:35:13 -07:00
.golangci.yml chore(go): update to go 1.22 (#3708) 2024-04-22 13:23:52 -07:00
.prettierignore Added moderator menu to messages and some other styling. 2022-07-01 22:53:56 +02: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 chore(deps): update alpine docker tag to v3.20.1 2024-06-20 18:42:39 +00:00
Earthfile fix: export correct timestamps on build artifacts. Closes #3282 2023-08-27 21:45:40 -07:00
go.mod fix(deps): update module mvdan.cc/xurls to v2 (#3815) 2024-07-08 11:24:48 -07:00
go.sum fix(deps): update module mvdan.cc/xurls to v2 (#3815) 2024-07-08 11:24:48 -07:00
LICENSE Update LICENSE to be current (#3058) 2023-05-31 18:06:23 -07:00
main.go chore(api): reorganize web assets and codegen types+handlers 2024-07-01 20:14:17 -07:00
openapi.yaml chore(docs): attempt to hide opts by marking 204options as internal 2024-07-02 14:09:27 -07:00
README.md chore(docs): update readme to call out Lambda test for #3734 2024-06-02 15:06:02 -07:00
renovate.json Remove references to webv2 branch in docs and builds 2023-01-27 20:16:47 -08:00
sqlc.yaml Messages table fixes to improve query performance (#2026) 2022-08-03 10:21:55 -07:00

Owncast Logo

Take control over your content and stream it yourself.


License


Explore the docs »
View Demo · 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.22 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!

If you're new to the project, maybe you'd be interested in looking at Good First Issue.

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

Donors

The Owncast project is possible thanks to the people who make a donation to support us and our work. Thank you to all our donors who help keep Owncast running by donating on OpenCollective. You can support this project by becoming a backer/sponsor.

License

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

Support

  • Browser testing via
  • Project chat provided by
  • CDN services by
  • UI testing with Chromatic

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