Hugo + Owncast. Take control over your live stream video by running it yourself. Streaming + chat + static site 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.
 
 
 
 
 
 
Johan Vandegriff a0e4a4d3cc
removed special page for search engine bots
2 months ago
.github merge 4 months ago
.vscode Add support for IP-based bans (#1703) 9 months ago
activitypub merge 4 months ago
auth merge 4 months ago
build Lock file maintenance (#2007) 4 months ago
config hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
controllers removed special page for search engine bots 2 months ago
core hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
db merge 4 months ago
docs Commit updated API documentation 5 months ago
examples Remove overly complex and specific docker-compose examples. Closes #1475 1 year ago
geoip refactor geoip (#1442) 1 year ago
hugo-template added RSS button to lists 2 months ago
logging Expanded linting + fix warnings (#1396) 1 year ago
metrics Fix up the wasted CPU transcoding alert message 7 months ago
models Surface the % of players represented in metrics 8 months ago
notifications merge 4 months ago
router hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
static Update admin to 19c9ac698ac49922046fd8f2a5b0b816dc6e921a 5 months ago
test Use the race detector when running automated tests. 4 months ago
utils Add a bit of sanity to the stream health messages 8 months ago
webroot added background color param for embedded chat 2 months ago
yp refactor: move from io/ioutil to io and os packages (#1546) 1 year ago
.editorconfig Change .editorconfig to reflect current state of the code (#1944) 6 months ago
.gitattributes doc -> docs as Github needs a specific name 8 months ago
.gitignore initial hugo integration 4 months ago
.golangci.yml Explicitly set go version in linter config. 8 months ago
.prettierignore Format javascript on push 2 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2 years ago
CONTRIBUTING.md Create CONTRIBUTING.md (#1394) 1 year ago
Dockerfile hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
Earthfile merge 4 months ago
LICENSE Create LICENSE 2 years ago
README.md Link the Docker Pull badge to Dockerhub (#1948) 5 months ago
go.mod hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
go.sum hugo defaults, docker build, reliable change detection, template updates, removed csp 3 months ago
main.go Fix "invalid cross-device link" error when running on a different filesystem (#1769) 9 months ago
openapi.yaml Standardize endpoint name and fix doc. Closes #1966 5 months ago
renovate.json Remove schedule from renovate 8 months ago
sqlc.yaml merge 4 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@fosstodon.org - email gabek@real-ity.com

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