Navy.gif/owncast
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Forked from https://github.com/owncast/owncast/tree/v0.1.2 https://github.com/owncast/owncast
1,385 Commits 1 Branch 0 Tags 688 MiB
TypeScript 41.4%
Go 41.3%
JavaScript 6.8%
MDX 3.4%
SCSS 2.4%
Other 4.6%
af7720a483
Go to file
Gabe Kangas af7720a483
Use the same screenshot as the web site 
It's fancier.
2021-08-14 20:24:54 -07:00
.github Increase golangci-lint timeout 2021-08-12 21:33:11 -07:00
.vscode
build Update micromodal 2021-08-13 00:05:22 -07:00
config Move emoji directory definition to config (#1317) 2021-08-14 12:48:04 -07:00
controllers Move emoji directory definition to config (#1317) 2021-08-14 12:48:04 -07:00
core Fix build error on FreeBSD. Closes #1243 2021-08-13 15:34:00 -07:00
doc Commit updated API documentation 2021-07-22 00:20:22 +00:00
examples
geoip Restore GeoIP support to now support chat users. Closes #1304 2021-08-13 08:52:36 +02:00
logging Fix initial creation of logging directory 2021-07-11 17:08:51 -07:00
metrics
models Support assigning nil as time instead of setting time as invalid. Fix typo that led to incorrect disconnect time. Maybe addresses #1268? 2021-08-03 17:47:16 -07:00
router Fix status code for options requests (#1290) 2021-08-03 12:23:20 -07:00
static
test Add automated integration test for client list API. 2021-08-13 08:52:36 +02:00
utils Using the full IP address for ClientID. 2021-08-07 12:35:02 -07:00
webroot Update micromodal 2021-08-13 00:05:22 -07:00
yp Support assigning nil as time instead of setting time as invalid. Fix typo that led to incorrect disconnect time. Maybe addresses #1268? 2021-08-03 17:47:16 -07:00
.editorconfig
.gitattributes
.gitignore Save owncast logs to log file. Closes #908 2021-05-22 19:25:54 -07:00
.golangci.yml Cleanup linter warnings 2021-07-19 23:49:16 -07:00
.prettierignore
CODE_OF_CONDUCT.md
Dockerfile Fix the passed in version number not being used due to an incorrect var 2021-06-28 16:01:01 -07:00
go.mod Bump github.com/shirou/gopsutil (#1289) 2021-08-11 22:42:16 -07:00
go.sum Bump github.com/shirou/gopsutil (#1289) 2021-08-11 22:42:16 -07:00
LICENSE
main.go Cleanup linter warnings 2021-07-19 23:49:16 -07:00
openapi.yaml Clarify in routes and names that it is chat clients being returned 2021-07-21 17:19:15 -07:00
pkged.go Update admin bundle 2021-08-13 00:26:00 -07:00
README.md Use the same screenshot as the web site 2021-08-14 20:24:54 -07:00

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 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.

Configuration

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

Web interface + chat

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.

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.

Video storage options

Two ways of storing and distributing the video are supported.

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

Local file distribution

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.

S3-Compatible Storage

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.

Building from Source

  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.

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. 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

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@mastodon.social - email gabek@real-ity.com

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