2020-09-23 11:52:12 +00:00
# Ghostream
2020-09-25 13:26:33 +00:00
[](LICENSE)
2020-09-28 08:51:20 +00:00
[](https://pkg.go.dev/mod/gitlab.crans.org/nounous/ghostream)
2020-09-28 08:53:10 +00:00
[](https://goreportcard.com/report/gitlab.crans.org/nounous/ghostream)
2020-10-05 08:34:58 +00:00
[](https://gitlab.crans.org/nounous/ghostream/commits/dev)
[](https://gitlab.crans.org/nounous/ghostream/-/commits/dev)
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.
2020-09-29 11:43:49 +00:00
- SRT stream input, supported by FFMpeg, OBS and Gstreamer.
2020-09-23 11:52:12 +00:00
- Low-latency streaming, sub-second with web player.
2020-10-01 21:33:29 +00:00
- Authentication of incoming stream using LDAP server.
2020-09-30 13:07:36 +00:00
- Possibility to forward stream to other streaming servers.
2020-09-23 11:52:12 +00:00
2020-09-28 14:29:24 +00:00
## Installation on Debian/Ubuntu
2020-09-30 14:36:59 +00:00
You need at least libsrt 1.4.1. On Ubuntu 20.04 or Debian Buster, you may manually install [libsrt-openssl-dev ](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 ).
2020-09-28 14:29:24 +00:00
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
2020-09-27 19:21:32 +00:00
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-29 13:31:08 +00:00
docker run -it --rm -p 2112:2112 -p 9710:9710/udp -p 8080:8080 -p 10000-10005:10000-10005/udp ghostream
2020-09-27 20:13:51 +00:00
```
2020-10-09 15:37:32 +00:00
## Configuration
Ghostream can be configured by placing [ghostream.yml ](docs/ghostream.example.yml ) in current directory, in `~/.ghostream/` or in `/etc/ghostream/` .
You can also override any value using environnement variables, e.g. `GHOSTREAM_AUTH_BACKEND=ldap` will change the authentification backend.
2020-09-29 11:36:12 +00:00
## Streaming
As stated by OBS wiki, when streaming you should adapt the latency to `2.5 * (the round-trip time with server, in μs)` .
2020-09-29 11:43:49 +00:00
### With OBS
As OBS uses FFMpeg, you need to have FFMpeg compiled with SRT support. To check if SR is available, run `ffmpeg -protocols | grep srt` .
On Windows and MacOS, OBS comes with his own FFMpeg that will work.
2020-10-04 09:20:25 +00:00
In OBS, go to "Settings" -> "Output" -> "Recording" the select "Output to URL" and change the URL to `srt://127.0.0.1:9710?streamid=demo:demo` .
For container, you may use MPEGTS for now (will change).
2020-09-29 11:43:49 +00:00
2020-09-29 11:36:12 +00:00
### With GStreamer
To stream X11 screen,
```bash
gst-launch-1.0 ximagesrc startx=0 show-pointer=true use-damage=0 \
! videoconvert \
! x264enc bitrate=32000 tune=zerolatency speed-preset=veryfast byte-stream=true threads=1 key-int-max=15 intra-refresh=true ! video/x-h264, profile=baseline, framerate=30/1 \
! mpegtsmux \
2020-10-02 20:39:38 +00:00
! srtserversink uri=srt://127.0.0.1:9710/ latency=1000000 streamid=demo:demo
2020-09-29 11:36:12 +00:00
```
2020-10-03 16:28:06 +00:00
## Playing stream
### With a web browser and WebRTC
Ghostream expose a web server on `0.0.0.0:8080` by default.
2020-10-03 16:28:42 +00:00
By opening this in a browser, you will be able to get instructions on how to stream, and if you append `/streamname` to the URL, then you will be able to watch the stream named `streamname` .
2020-10-03 16:28:06 +00:00
The web player also integrates a side widget that is configurable.
### With ffplay
You may directly open the SRT stream with ffplay:
```bash
ffplay -fflags nobuffer srt://127.0.0.1:9710?streamid=demo
```
2020-10-04 09:20:25 +00:00
### With MPV
As MPV uses ffmpeg libav, support for SRT streams can be easily added.
[See current pull request. ](https://github.com/mpv-player/mpv/pull/8139 )
2020-10-03 19:16:48 +00:00
## Troubleshooting
### ld returns an error when launching ghostream
When using `libsrt-gnutls-dev` rather than `libsrt-openssl-dev` on Debian/Ubuntu,
then srtgo package is unable to build.
```bash
~/ghostream$ go run main.go
# github.com/haivision/srtgo
2020-10-03 19:19:57 +00:00
/usr/bin/ld: cannot find -lsrt
/usr/bin/ld: cannot find -lsrt
/usr/bin/ld: cannot find -lsrt
2020-10-03 19:16:48 +00:00
collect2: error: ld returned 1 exit status
```
The solution is to switch to `libsrt-openssl-dev` .
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/ )
2020-09-29 11:14:26 +00:00
- OBS Wiki, *[Streaming With SRT Protocol.](https://obsproject.com/wiki/Streaming-With-SRT-Protocol)*
2020-10-06 06:41:10 +00:00
- Livepeer media server, *[Evaluate Go-FFmpeg Bindings](https://github.com/livepeer/lpms/issues/24)*
