Take control over your live stream video by running it yourself. Streaming + chat out of the box.
Find a file
2023-03-09 20:29:48 +00:00
.design Add additional details to the design help doc. 2023-02-21 13:42:20 -08:00
.github Update peter-evans/create-or-update-comment digest to 44526e3 2023-03-08 06:03:47 +00:00
.vscode Add support for IP-based bans (#1703) 2022-03-06 20:34:49 -08:00
activitypub validate response of federation APIs (#2408) 2022-12-10 21:10:10 -08:00
auth Enforce https before indieauth parsing. For #2492 2022-12-23 20:50:12 -08:00
build chore(deps): lock file maintenance (#2643) 2023-01-30 11:24:38 -08:00
config Tweak default page content 2023-01-23 20:50:54 -08:00
contrib Example varnish and hitch config (#2655) 2023-01-31 11:19:21 -08:00
controllers Do not support stream key UI or any persisted stream keys when overridden via cli flag. Closes #2749 2023-02-27 17:08:52 -08:00
core Do not support stream key UI or any persisted stream keys when overridden via cli flag. Closes #2749 2023-02-27 17:08:52 -08:00
db Add support for changing user color in name modal. Closes #1805 2022-08-09 19:56:45 -07:00
docs Update WIP backend diagram 2023-02-23 12:35:55 -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 Fix CPU usage collection panic with default zero value. Closes #2423 2022-12-09 09:49:17 -08:00
models Allow embedding HTML for external actions (#2693) 2023-02-14 09:08:54 -08:00
notifications Change Owncast Avatar URL for discord hooks (#2748) 2023-02-27 11:12:22 -08:00
router Fix chat embed redirect breaking chat embeds. Closes #2739 2023-02-26 14:20:31 -08:00
static Bundle embedded web app 2023-03-09 20:29:48 +00:00
test Add chat embed automated browser tests. Closes #2743 2023-02-26 19:06:22 -08:00
utils Do not cache HTML pages. Closes #2613 2023-01-22 22:27:27 -08:00
web chore(deps): update typescript-eslint monorepo to v5.54.1 2023-03-09 17:54:21 +00:00
yp refactor: move from io/ioutil to io and os packages (#1546) 2021-11-19 22:42:50 -08: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 add shellcheck to CI (#2478) 2022-12-25 19:17:13 -08:00
.gitpod.yml Add Gitpod config (#2173) 2022-10-05 15:35:13 -07:00
.golangci.yml bump min golang ver to 1.18 (#2412) 2022-12-06 14:31:08 -08: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 Update alpine Docker tag to v3.17.2 2023-02-11 02:05:12 +00:00
Earthfile Add HLS test to Earthfile 2023-01-22 21:23:23 -08:00
go.mod Update module github.com/microcosm-cc/bluemonday to v1.0.23 2023-03-07 21:00:24 +00:00
go.sum Update module github.com/microcosm-cc/bluemonday to v1.0.23 2023-03-07 21:00:24 +00:00
LICENSE Create LICENSE 2020-07-08 17:07:09 -07:00
main.go Add details to temp dir removal error 2023-01-08 14:18:16 -08:00
openapi.yaml Update OpenApi spec to reflect v0.1.0. For #2431 2023-01-24 14:02:26 -08:00
README.md Add mention of Browserstack for open source program. (#2692) 2023-02-07 22:11:55 -08: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


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 written in Go.
  2. The frontend 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.

Backend

The Owncast backend is a service written in Go.

  1. Ensure you have pre-requisites installed.
  2. Install the Go toolchain (1.18 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 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