Installing and running Sapsan¶
This page describes how to install Sapsan, run it with a minimal configuration, and verify that the server works.
Before installation¶
Note
TODO: system requirements (OS, architectures, CPU/RAM, DVR disks).
Installing from the deb package¶
Sapsan is distributed as the sapsan deb package from the Flussonic repository:
echo "deb http://apt.flussonic.com binary/" > /etc/apt/sources.list.d/flussonic.list
apt update
apt install sapsan
Running in Docker¶
The official image is flussonic/sapsan. Map the ports and the configuration file into the container:
docker run -d --name sapsan \
-p 80:80 -p 554:554 -p 1935:1935 \
-v /etc/sapsan/sapsan.yaml:/etc/sapsan/sapsan.yaml \
-v /storage:/storage \
flussonic/sapsan
Note
TODO: exact config path inside the image, environment variables, UDP ports for SRT/WebRTC.
Minimal configuration¶
Sapsan reads its configuration from sapsan.yaml (the path can be overridden with the CONFIG_PATH environment variable). A minimal config is one HTTP port and one stream:
listeners:
http:
- port: 80
streams:
demo:
inputs:
- syntetic: {}
transcoder:
output:
- source: !content video
codec: !set h264
- source: !content audio
codec: !set aac
Starting and stopping¶
sapsan
# or with an explicit config path:
CONFIG_PATH=/etc/sapsan/sapsan.yaml sapsan
- Reload the configuration without interrupting streaming:
kill -HUP <pid>. - Gracefully stop the server:
kill -TERM <pid>.
Note
TODO: systemd unit, default logs, where to check status.
Health check¶
Open the test stream playlist:
curl http://localhost/streaming/v/demo/index.m3u8
If the server returns a playlist, Sapsan is installed and running. Next, configure real video ingest.