Xiu is a simple and secure live media server written by pure Rust, it now supports popular live protocols like RTMP/HLS/HTTP-FLV (and maybe other protocols in the future), you can deploy it as a stand-alone server or a cluster using the relay feature.
Features
- RTMP
- publish and play
- relay: static push
- relay: static pull
- HTTPFLV
- HLS
- SRT
Preparation
Install Rust and Cargo
Install and run
There are two ways to install xiu :
- Using cargo to install
- Building from source
Install using cargo
Issue the following command to install xiu:
cargo install xiu
Start the service with the following command:
xiu configuration_file_path/config.toml
Build from souce
Clone Xiu
git clone https://github.com/harlanc/xiu.git
use master branch
Build
cd ./xiu/application/xiu
cargo build --release
Run
cd ./xiu/target/release
./xiu config.toml
Configurations
RTMP
[rtmp]
enabled = true
port = 1935
# pull streams from other server node.
[rtmp.pull]
enabled = false
address = "192.168.0.1"
port = 1935
# push streams to other server node.
[[rtmp.push]]
enabled = true
address = "localhost"
port = 1936
[[rtmp.push]]
enabled = true
address = "192.168.0.3"
port = 1935
HTTPFLV
[httpflv]
# true or false to enable or disable the feature
enabled = true
# listening port
port = 8081
HLS
[hls]
# true or false to enable or disable the feature
enabled = true
# listening port
port = 8080
Log
[log]
level = "info"
Configuration examples
I edit some configuration files under the following path which can be used directly:
xiu/application/xiu/src/config
It contains the following 4 files:
config_rtmp.toml //enable rtmp only
config_rtmp_hls.toml //enable rtmp and hls
config_rtmp_httpflv.toml //enable rtmp and httpflv
config_rtmp_httpflv_hls.toml //enable all the 3 protocols
Scenarios
Push
You can use two ways:
-
Use OBS to push a live rtmp stream
-
Or use FFmpeg to push a rtmp stream:
ffmpeg -re -stream_loop -1 -i test.mp4 -c:a copy -c:v copy -f flv -flvflags no_duration_filesize rtmp://127.0.0.1:1935/live/test
Play
Use ffplay to play the rtmp/httpflv/hls live stream:
ffplay -i rtmp://localhost:1935/live/test
ffplay -i http://localhost:8081/live/test.flv
ffplay -i http://localhost:8080/live/test/test.m3u8
Relay - Static push
The configuration files are as follows:
The configuration file of Service 1 named config.toml:
[rtmp]
enabled = true
port = 1935
[[rtmp.push]]
enabled = true
address = "localhost"
port = 1936
The configuration file of Service 2 named config_push.toml:
[rtmp]
enabled = true
port = 1936
Run the 2 services:
./xiu config.toml
./xiu config_push.toml
Use the above methods to push rtmp live stream to service 1, then the stream can be pushed to service 2 automatically, you can play the same live stream from both the two services:
ffplay -i rtmp://localhost:1935/live/test
ffplay -i rtmp://localhost:1936/live/test
Relay - Static pull
The configuration file are as follows:
The configuration file of Service 1 named config.toml:
[rtmp]
enabled = true
port = 1935
The configuration file of Service 2 named config_pull.toml:
[rtmp]
enabled = true
port = 1936
[rtmp.pull]
enabled = false
address = "localhost"
port = 1935
Run the 2 services:
./xiu config.toml
./xiu config_pull.toml
Use the above methods to push live stream to service 1, when you play the stream from serivce 2, it will pull the stream from service 1:
ffplay -i rtmp://localhost:1935/live/test
ffplay -i rtmp://localhost:1936/live/test
Star History
Thanks
Others
Open issues if you have any problems. Star and pull requests are welcomed. Your stars can make this project go faster and further.