[New App] Owncast (#826)

This commit is contained in:
Osco 2023-07-19 19:04:59 -04:00 committed by GitHub
parent d2cdcb8a05
commit 3f7c059bf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 121 additions and 0 deletions

View File

@ -92,6 +92,7 @@ This is the official repository for the Tipi App Store. It contains all the apps
- [OneDev](https://code.onedev.io/onedev/server) - Self-hosted Git Server with Kanban and CI/CD
- [Openbooks](https://github.com/evan-buss/openbooks) - Search and Download eBooks
- [Overseerr](https://github.com/sct/overseerr) - Request management and media discovery tool for the Plex ecosystem
- [Owncast](https://github.com/owncast/owncast) - Take control over your live stream video by running it yourself. Streaming + chat out of the box.
- [Owncloud](https://github.com/owncloud/core) - A personal cloud which runs on your own server.
- [PairDrop](https://github.com/schlagmichdoch/PairDrop) - Local file sharing in your browser. Inspired by Apple's AirDrop.
- [Paperless-ngx](https://github.com/paperless-ngx/paperless-ngx) - Document Management System (DMS)

17
apps/owncast/config.json Executable file
View File

@ -0,0 +1,17 @@
{
"$schema": "../schema.json",
"name": "Owncast",
"available": true,
"port": 8198,
"exposable": true,
"id": "owncast",
"description": "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.",
"tipi_version": 1,
"version": "0.1.0",
"categories": ["media"],
"short_desc": " Take control over your live stream video by running it yourself. Streaming + chat out of the box. ",
"author": "Owncast",
"source": "https://github.com/owncast/owncast",
"website": "https://owncast.online/",
"form_fields": []
}

43
apps/owncast/docker-compose.yml Executable file
View File

@ -0,0 +1,43 @@
version: '3.9'
services:
owncast:
container_name: owncast
image: owncast/owncast:0.1.0
volumes:
- ${APP_DATA_DIR}/data:/app/data
ports:
- ${APP_PORT}:8080 # App Port
- 1935:1935 # RTMP Port
restart: unless-stopped
networks:
- tipi_main_network
labels:
# Main
traefik.enable: true
traefik.http.middlewares.owncast-web-redirect.redirectscheme.scheme: https
traefik.http.services.owncast.loadbalancer.server.port: 8080
traefik.tcp.services.owncast-rtmp.loadbalancer.server.port: 1935
# Web
traefik.http.routers.owncast-insecure.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.owncast-insecure.entrypoints: web
traefik.http.routers.owncast-insecure.service: owncast
traefik.http.routers.owncast-insecure.middlewares: owncast-web-redirect
traefik.tcp.routers.owncast-rtmp-insecure.rule: HostSNI(`${APP_DOMAIN}`)
# Websecure
traefik.http.routers.owncast.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.owncast.entrypoints: websecure
traefik.http.routers.owncast.service: owncast
traefik.http.routers.owncast.tls.certresolver: myresolver
traefik.tcp.routers.owncast-rtmp.rule: HostSNI(`${APP_DOMAIN}`)
# Local domain
traefik.http.routers.owncast-local-insecure.rule: Host(`owncast.${LOCAL_DOMAIN}`)
traefik.http.routers.owncast-local-insecure.entrypoints: web
traefik.http.routers.owncast-local-insecure.service: owncast
traefik.http.routers.owncast-local-insecure.middlewares: owncast-web-redirect
traefik.tcp.routers.owncast-rtmp-local-insecure.rule: HostSNI(`owncast.${LOCAL_DOMAIN}`)
# Local domain secure
traefik.http.routers.owncast-local.rule: Host(`owncast.${LOCAL_DOMAIN}`)
traefik.http.routers.owncast-local.entrypoints: websecure
traefik.http.routers.owncast-local.service: owncast
traefik.http.routers.owncast-local.tls: true
traefik.tcp.routers.owncast-rtmp-local.rule: HostSNI(`owncast.${LOCAL_DOMAIN}`)

View File

@ -0,0 +1,60 @@
## Initial Setup Notice
### Setting Up an Exposed Instance with SSL Certs
As Owncast uses the RTMP protocol for ingesting incoming streams, the typical Cloudflare Zero Access configuration will not work as it does not have RTMP as an option for routing.
You can optionally follow [this guide](https://gist.github.com/HeyOsco/6e8102d7d82ffaeaae16f41bef98b739) for setting up an exposed Owncast server with your RunTipi instance.
### Admin Dashboard Access
To access the admin dashboard, simply visit `/admin` in your browser.
The login username is set to `admin`.
The password to login is initially set to the stream key, which is `abc123` by default.
### Security Recommendations
For security reasons, we highly encourage you to change both the stream key and your admin password immediately after installation. You can do this by visiting `/admin/config/server/` and following the provided instructions.
### Additional Configuration
For more detailed configuration options, please refer to the documentation available at https://owncast.online/docs/configuration/.
## 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](https://watch.owncast.online) for an example.
## 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 youre currently using one of those its 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](https://owncast.online/docs/broadcasting/).
## 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 wed 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](https://owncast.online/contribute/) and feel strongly about open, appreciative, and empathetic people joining us.
Weve 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](https://owncast.online/help/).
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Supported by
- This project is tested with [BrowserStack](https://browserstack.com).
## Contact
Project chat: [Join us on Rocket.Chat](https://owncast.rocket.chat/home) if you want to contribute, follow along, or if you have questions.
Gabe Kangas - [@gabek@social.gabekangas.com](https://social.gabekangas.com/gabek) - email [gabek@real-ity.com](mailto:gabek@real-ity.com)
Project Link: [https://github.com/owncast/owncast](https://github.com/owncast/owncast)

BIN
apps/owncast/metadata/logo.jpg Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB