hobbit19 / owncast Goto Github PK

• About the Project
• Getting Started
  • Getting Started
  • Configuration
  • Web Interface & Chat
• Use with your broadcasting software
• Video storage and distribution options
• Building from source
• License
• Contact

Owncast is an open source, self-hosted, decentralized, single user live 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.

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.

Many aspects can be adjusted and customized to your preferences. Read more about Configuration to update the web UI, video settings, and more.

Owncast includes a web interface to your video with built-in chat that is available once you start the server.

The web interface was specifically built to be editable by anybody comfortable tweaking a web page. It's not bundled or transpiled into anything, it's just HTML + Javascript + CSS that you can start editing.

Read more about the features provided and how to configure them in the web documentation.

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.

Two ways of storing and distributing the video are supported.

1. Locally via the Owncast server.
2. S3-compatible storage.

This is the simplest and works out of the box. In this scenario video will be served to the public from the computer that is running the server. If you have a fast internet connection, enough bandwidth alotted to you, and a small audience this may be fine for many people.

Instead of serving video directly from your personal server you can use a S3 compatible storage provider to offload the bandwidth and storage requirements elsewhere.

Read more detailed documentation about configuration of S3-compatible services.

1. Ensure you have the gcc compiler configured.
2. Install the Go toolchain.
3. Clone the repo. git clone https://github.com/owncast/owncast
4. go run main.go pkged.go will run from source.
5. 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.

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. Install pkger. go install github.com/markbates/pkger/cmd/...
2. From the owncast directory run the packager script: ./build/admin/bundleAdmin.sh
3. Compile or run like above. go run main.go pkged.go

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

Project chat: Join us on Rocket.Chat if you want to contribute, follow along, or if you have questions.

Gabe Kangas - @[email protected] - email [email protected]

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