Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x186k/deadsfu
Dead-simple WebRTC broadcasting. From the browser, or your application. Cloud-native and scalable.
https://github.com/x186k/deadsfu
broadcasting docker go golang kubernetes livestreaming low-latency real-time streaming webrtc
Last synced: about 1 month ago
JSON representation
Dead-simple WebRTC broadcasting. From the browser, or your application. Cloud-native and scalable.
- Host: GitHub
- URL: https://github.com/x186k/deadsfu
- Owner: x186k
- License: mit
- Created: 2020-12-29T21:27:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-26T23:37:22.000Z (almost 3 years ago)
- Last Synced: 2024-12-01T01:03:25.644Z (about 1 month ago)
- Topics: broadcasting, docker, go, golang, kubernetes, livestreaming, low-latency, real-time, streaming, webrtc
- Language: Go
- Homepage: https://deadsfu.com
- Size: 12.1 MB
- Stars: 42
- Watchers: 6
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - x186k/deadsfu - Dead-simple WebRTC broadcasting. From the browser, or your application. Cloud-native and scalable. (Go)
README
## Dead-simple Scalable WebRTC Broadcasting
**DeadSFU**: dead-simple broadcasting and video transmission.
## Quick Links
- [Feature List](#feature-list)
- [Quick Install](#quick-install)
- [Quick Start: OBS / FTL ingress](#quick-start-obs--ftl-ingress)
- [Quick Start: Browser Ingress](#quick-start-browser-ingress)
- [Getting Support](#getting-support)
- [Email Newsletter](#email-newsletter)
- [Contributing](#contributing)
- [Getting Latest Updates](#getting-latest-updates)
- [Compile From Source](#compile-from-source)
- [DeadSFU Thanks](#deadsfu-thanks)
[WHIP]: https://www.ietf.org/archive/id/draft-ietf-wish-whip-00.html
## Feature List
- **Dead-Simple Usage:** Meticulously crafted for ease-of-use, scalability, and performance.
- **Large Scale WebRTC Broadcasting:** SFUs can be easily cascaded to create clusters of hundreds of servers.
- **Cloud Native Docker:** Ready to go Docker images for cloud-native broadcasting clusters.
- **Auto Scaling Compatible:** HTTP signalling is compatible with most cluster-autoscaling methods.
- **OBS Broadcasting:** Send from OBS to DeadSFU for doing WebRTC broadcasting.
- **Browser Viewer:** Browser viewer enables watching broadcasts.
- **Simple Ingress HTTPS Signalling:** [WHIP][WHIP] compatible: Send an Offer-SDP, get an Answer-SDP, and you're publishing!
- **Simple Egress HTTPS Signalling:** WHIP-like: Send an Offer-SDP, get an Answer-SDP, and you're receiving!
- **Designed For Fault Tolerance:** Single-peer-ingress design for practical large-scale fault-tolerant containerized broadcasting.
- **Kubernetes/Docker capable:** Designed for Kubernetes or Swarm broadcasting clusters.
- **HTTP load balancer compatible:** Designed standard HTTP load balancer compatibility on egress.
- **Dead-simple Install:** Use a one-liner curl & untar command to prepare to broadcast.
- **No Runtime Dependencies:** DeadSFU is a single binary that you can run locally or in production with a single command.
**Don't see a feature on this list?** Check the issue track to see if your feature is there, if not open a new issue. We need your input to make our roadmap, and we'd love to hear from you.
## Quick Install
Linux Intel/AMD64
```bash
curl -sL https://github.com/x186k/deadsfu/releases/latest/download/deadsfu-linux-amd64.tar.gz | tar xvz
```
Linux ARM64
```bash
curl -sL https://github.com/x186k/deadsfu/releases/latest/download/deadsfu-linux-arm64.tar.gz | tar xvz
```
macOS Intel CPU
```bash
curl -sL https://github.com/x186k/deadsfu/releases/latest/download/deadsfu-darwin-amd64.tar.gz | tar xvz
```
macOS Apple CPU
```bash
curl -sL https://github.com/x186k/deadsfu/releases/latest/download/deadsfu-darwin-arm64.tar.gz | tar xvz
```
Docker Pull
```bash
docker pull x186k/deadsfu
```
Windows
```bash
curl https://github.com/x186k/deadsfu/releases/latest/download/deadsfu-windows-amd64.zip -sLo tmp && tar -xvf tmp && del tmp
```
## Quick Start: OBS / FTL ingress
Remove the --ftl-key args if you are not using OBS/FTL.
Linux/macOS
```bash
./deadsfu --http :8080 --html internal --ftl-key 123-abc
```
Windows
```
.\\deadsfu --http :8080 --html internal --ftl-key 123-abc
```
Docker Host Networking (recommended) Only Works on Linux
```bash
docker run --name deadsfu --pull always --network host x186k/deadsfu --http :8080 --html internal --ftl-key 123-abc
```
Host networking can ease WebRTC connecting in difficult environments. The SFU can share the true host IP addresses.
Docker Forwarded Ports (Mac,Win,Linux)
```bash
docker run --name deadsfu --pull always -p 8080:8080 -p 8084:8084/udp -p 8084:8084/tcp x186k/deadsfu --http :8080 --html internal --ftl-key 123-abc
```
## Quick Start: Browser Ingress
#### Not Yet, file an issue for help
## Getting Support
Author's email is `[email protected]`
Slack link: [Slack Invite Link](https://join.slack.com/t/deadsfu/shared_invite/zt-sv23oa10-XFFYoJHPty8BtuCmBthH_A)
## Email Newsletter
[Get the email newletter.](https://docs.google.com/forms/d/e/1FAIpQLSd8rzXabvn73YC_GPRtXZb1zlKPeOEQuHDdVi4m9umJqEaJsA/viewform)
## Contributing
If you have an idea to share, please post it on the [Github discussions](https://github.com/x186k/deadsfu/discussions/categories/ideas) board.
If you have found a bug, please file an issue on [Github issues](https://github.com/x186k/deadsfu/issues)
If you have suggestions or ideas, please submit an issue or create a discussion. Your ideas are wanted!
## Getting Latest Updates
You can update by simply re-running the `curl` and `tar` commands again as in the install directions.
For Docker, simply re-pull the latest image.
## Compile From Source
The deadsfu repo includes git submodules.
So, use the `--recursive` flag when checking out. [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
You need a version of Go greater than 1.16, we recommend 1.17 or later.
Clone the main repo:
```bash
git clone --recursive https://github.com/x186k/deadsfu
```
Change dir:
```bash
cd deadsfu
```
Build with Go:
```bash
go build .
```
## DeadSFU Thanks
- [Sean Dubois](https://github.com/Sean-Der) Creator of Pion
- [Luis Orlando](https://github.com/OrlandoCo) Pion help code
- [Juliusz Chroboczek](https://github.com/jech) Pion help and code
- [Matt Holt](https://github.com/mholt) Creator of Caddy
- [Francis Lavoie](https://github.com/francislavoie) Caddy maintainer
- [Alex Williams](https://github.com/llspalex) Louper founder, inspiration.
- [Sayan Bhattacharya](https://github.com/Thunder80) Louper developer.
- [Charles Surett](https://github.com/scj643) Early user.
- [Alex Peder](https://artiflix.com/) Project supporter.
- [Akash](https://github.com/discist) Early user.