Add README content about the web UI
This commit is contained in:
parent
e4cf5e6030
commit
d2d4b4034c
10
README.md
10
README.md
@ -27,6 +27,7 @@
|
|||||||
* [Prerequisites](#prerequisites)
|
* [Prerequisites](#prerequisites)
|
||||||
* [Getting Started](#getting-started)
|
* [Getting Started](#getting-started)
|
||||||
* [Configuration](#configuration)
|
* [Configuration](#configuration)
|
||||||
|
* [Web Interface & Chat](#web-interface--chat)
|
||||||
* [Use with your software](#use-with-your-desktop-software)
|
* [Use with your software](#use-with-your-desktop-software)
|
||||||
* [OBS & Streamlabs](#usage-with-obs)
|
* [OBS & Streamlabs](#usage-with-obs)
|
||||||
* [Restream](#usage-with-restream)
|
* [Restream](#usage-with-restream)
|
||||||
@ -74,6 +75,15 @@ The goal is to have a single service that you can run and it works out of the bo
|
|||||||
|
|
||||||
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](/doc/configuration.md) to update the web UI and video easily.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
## Use with your desktop software
|
## Use with your desktop software
|
||||||
|
|
||||||
### Usage with OBS
|
### Usage with OBS
|
||||||
|
Loading…
x
Reference in New Issue
Block a user