mirrors/owncast
1
0
Fork 0
mirror of https://github.com/owncast/owncast.git synced 2024-11-21 20:28:15 +03:00
Code Issues Projects Releases Packages Wiki Activity

Update README to point to owncast.online documentation

Browse source
This commit is contained in:
Gabe Kangas 2020-08-23 12:16:33 -07:00
parent cf7ff0a820
commit f864057df3
1 changed files with 19 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
README.md
View file

@ -1,6 +1,6 @@
<br />
<p align="center">
<a href="https://github.com/gabek/owncast" alt="Owncast">
<a href="https://github.com/owncast/owncast" alt="Owncast">
<img src="doc/logo.png" alt="Logo" width="200">
</a>
@ -8,14 +8,14 @@
<p align="center">
Take control over your content and stream it yourself.
<br />
<a href="https://github.com/gabek/owncast/tree/master/doc"><strong>Explore the docs »</strong></a>
<a href="http://owncast.online"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://goth.land/">View Demo</a>
·
<a href="https://github.com/gabek/owncast/tree/master/doc/faq.md">FAQ</a>
<a href="https://owncast.online/docs/faq/">FAQ</a>
.
<a href="https://github.com/gabek/owncast/issues">Report Bug</a>
<a href="https://github.com/owncast/owncast/issues">Report Bug</a>
</p>
</p>
@ -24,13 +24,10 @@
* [About the Project](#about-the-project)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Getting Started](#getting-started)
* [Configuration](#configuration)
* [Web Interface & Chat](#web-interface--chat)
* [Use with your software](#use-with-your-desktop-software)
* [OBS & Streamlabs](#usage-with-obs)
* [Restream](#usage-with-restream)
* [Use with your broadcasting software](#use-with-your-existing-broadcasting-software)
* [Video storage and distribution options](#video-storage-options)
* [Building from source](#building-from-source)
* [License](#license)
@ -63,54 +60,28 @@ I figured you can install Wordpress and self-host your blog, or install Megento
---
<!-- GETTING STARTED -->
### Prerequisites
* **A computer that's on the public internet to run it on.** While crunching through video and serving it to viewers can be intensive from the computing side, you can get away with pretty meager resources on a simple setup. If you don't already have a server to run it on you can get a [Linode](https://www.linode.com/products/nanodes/) instance for $5/mo that runs it fine. If you worry that you'll be maxing out the bandwidth or transfer limits allotted to you, then utilize [S3 Storage](https://github.com/gabek/owncast/blob/master/doc/S3.md) very cheaply (or even free for a certain amount) to serve the files instead.
## Getting Started
The goal is to have a single service that you can run and it works out of the box. **Visit the [Quickstart](doc/quickstart.md) to get up and running.**
The goal is to have a single service that you can run and it works out of the box. **Visit the [Quickstart](https://owncast.online/docs/quickstart/) to get up and running.**
## Configuration
Many aspects can be adjusted and customized to your preferences. [Read more about Configuration](/doc/configuration.md) to update the web UI and video easily.
Many aspects can be adjusted and customized to your preferences. [Read more about Configuration](https://owncast.online/docs/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. It shows online/offline states, viewer counts, stream duration, your instance's description, images, links and more. You can just start using it without making any changes and it'll reflect whatever you put in the config file.
Owncast includes a web interface to your video with built-in chat that is available once you start the server.
If you want to add some additional content you can edit the [`/webroot/static/content.md`](https://github.com/gabek/owncast/blob/master/webroot/static/content-example.md) file. Anything you put in this using [markdown](https://www.markdownguide.org/) or HTML will display on the page without you having to touch the existing page. Some ideas here: Your Patreon or Paypal link to support donations, an embed of a Soundcloud track, some images, or an embedded social feed.
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.
However, 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. Feel free to add your own branding, links, change the colors in the CSS, fonts, layout, or anything else you could possibly want. No development environment is needed, just open the files in an editor and start tweaking.
Read more about the features provided and how to configure them in the [web documentation](https://owncast.online/docs/website/).
The web chat supports some basic formatting using markdown:
## Use with your existing broadcasting software
Italic: `*your text*`
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.
Bold: `**your text**`
Strikethrough: `~~your text~~`
Code blocks: <code>\`your text\`</code>
## Use with your desktop software
### Usage with OBS
OBS isn't required, but it's a pretty good piece of free software that will get you streaming from your own computer right away.
1. Install [OBS](https://obsproject.com/) or [Streamlabs OBS](https://streamlabs.com/) and get it working with your local setup.
1. Open OBS Settings and go to "Stream".
2. Select "Custom..." as the service.
3. Enter the URL of the server running your streaming service in the format of rtmp://myserver.net/live.
4. Enter your "Stream Key" that matches the key you put in your `config.yaml` file.
5. Start the server.
6. Press "Start Streaming" (OBS) or "Go Live" (Streamlabs) on OBS.
### Usage with Restream
Read the [detailed documentation for working with Restream](https://github.com/gabek/owncast/blob/master/doc/restream.md)
OBS, Streamlabs, Restream and many others have been used with Owncast. [Read more about compatibility with existing software](https://owncast.online/docs/broadcasting/).
## Video storage options
@ -125,19 +96,21 @@ This is the simplest and works out of the box. In this scenario video will be s
### S3-Compatible Storage
Enable S3 support in `config.yaml` and add your access credentials. Files will be distributed from a S3 bucket that you have created for this purpose. This is a good option for almost any case since S3 is cheap and you don't have to worry about your own bandwidth.
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](https://owncast.online/docs/s3/).
Please read the [more detailed documentation about configuration of S3-Compatible Services](https://github.com/gabek/owncast/blob/master/doc/S3.md).
## Building from Source
1. Ensure you have the gcc compiler configured.
1. Install the [Go toolchain](https://golang.org/dl/).
1. Clone the repo. `git clone https://github.com/gabek/owncast`
1. Clone the repo. `git clone https://github.com/owncast/owncast`
1. Follow the above [Getting Started](#getting-started) instructions, making sure ffmpeg exists and your config file is set.
1. `go run main.go` on the first run will download the required packages needed for the application to build.
1. It will start running the same as in the above [Usage](#usage) instructions and you can point [OBS to your localhost](#usage-with-obs) instance of it.
There is also a supplied `Dockerfile` so you can spin it up from source with little effort. [Read more about running from source](https://owncast.online/docs/building/).
<!-- LICENSE -->
## License
@ -151,4 +124,4 @@ Distributed under the MIT License. See `LICENSE` for more information.
Gabe Kangas - [@gabek@mastodon.social](https://mastodon.social/@gabek) - email [gabek@real-ity.com](mailto:gabek@real-ity.com)
Project Link: [https://github.com/gabek/owncast](https://github.com/gabek/owncast)
Project Link: [https://github.com/owncast/owncast](https://github.com/owncast/owncast)