ghostream/README.md

42 lines
2.1 KiB
Markdown
Raw Normal View History

2020-09-23 11:52:12 +00:00
# Ghostream
2020-09-25 13:26:33 +00:00
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
2020-09-28 08:51:20 +00:00
[![PkgGoDev](https://pkg.go.dev/badge/mod/gitlab.crans.org/nounous/ghostream)](https://pkg.go.dev/mod/gitlab.crans.org/nounous/ghostream)
2020-09-28 08:53:10 +00:00
[![Go Report Card](https://goreportcard.com/badge/gitlab.crans.org/nounous/ghostream)](https://goreportcard.com/report/gitlab.crans.org/nounous/ghostream)
2020-09-23 11:52:12 +00:00
[![pipeline status](https://gitlab.crans.org/nounous/ghostream/badges/master/pipeline.svg)](https://gitlab.crans.org/nounous/ghostream/commits/master)
[![coverage report](https://gitlab.crans.org/nounous/ghostream/badges/master/coverage.svg)](https://gitlab.crans.org/nounous/ghostream/-/commits/master)
2020-09-23 11:52:12 +00:00
*Boooo!* A simple streaming server with authentication and open-source technologies.
2020-09-25 13:26:33 +00:00
This project was developped at [Cr@ns](https://crans.org/) to stream events.
2020-09-23 11:52:12 +00:00
Features:
- WebRTC playback with a lightweight web interface.
- Low-latency streaming, sub-second with web player.
- Authentification of incoming stream using LDAP server.
2020-09-28 14:29:24 +00:00
## Installation on Debian/Ubuntu
You need at least libsrt 1.4.1. On Ubuntu 20.04 or Debian Buster, you may manually install [libsrt1-openssl](http://ftp.fr.debian.org/debian/pool/main/s/srt/libsrt1-openssl_1.4.1-5+b1_amd64.deb) then [libsrt-openssl-dev](http://ftp.fr.debian.org/debian/pool/main/s/srt/libsrt-openssl-dev_1.4.1-5+b1_amd64.deb).
You may clone this repository, then `go run main.go` for debugging, or `go get gitlab.crans.org/nounous/ghostream`.
2020-09-23 11:52:12 +00:00
## Installation with Docker
An example is given in [docs/docker-compose.yml](docs/docker-compose.yml).
2020-09-23 11:52:12 +00:00
It uses Traefik reverse proxy.
2020-09-27 20:13:51 +00:00
You can also launch the Docker image using,
```
2020-09-27 20:14:35 +00:00
docker build . -t ghostream
2020-09-27 20:13:51 +00:00
docker run -it --rm -p 8080:8080 -p 2112:2112 -p 9710:9710 ghostream
```
2020-09-23 11:52:12 +00:00
## References
- Phil Cluff (2019), *[Streaming video on the internet without MPEG.](https://mux.com/blog/streaming-video-on-the-internet-without-mpeg/)*
- MDN web docs, *[Signaling and video calling.](https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API/Signaling_and_video_calling)*
2020-09-24 17:01:26 +00:00
- [WebRTC For The Curious](https://webrtcforthecurious.com/)