aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMistivia <i@mistivia.com>2025-09-15 03:23:03 +0800
committerMistivia <i@mistivia.com>2025-09-15 03:23:03 +0800
commit27bab64a8ad63fc9b51bd8e15d249cd0e51de67a (patch)
tree06bd1ea7bc38db4d5e5964739dc2c61c35d3080c
parentea1ee974e7034c8ebc903b434b5b9f1cb466fee8 (diff)
update readme
-rw-r--r--.gitignore6
-rw-r--r--Readme.md30
2 files changed, 35 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 91e8753..1c82cfb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,8 @@ ezlive
*.ts
*.m3u8
a.out
-config \ No newline at end of file
+config
+rootfs
+conf
+Dockerfile
+*.tar.gz \ No newline at end of file
diff --git a/Readme.md b/Readme.md
index 3bf26c8..e2c870d 100644
--- a/Readme.md
+++ b/Readme.md
@@ -48,6 +48,36 @@ Then use a HLS player to load `https://YOUR_BUCKET_NAME.our-oss.com/ezlive/strea
If you don't know how to setup a HLS player, then make sure you have added `https://mistivia.github.io` in your OSS's CORS setting, then open `https://mistivia.github.io/ezlive#https://YOUR_BUCKET_NAME.our-oss.com/ezlive/stream.m3u8`.
+# Docker Usage
+
+Download the docker image tarball in [release](https://github.com/mistivia/ezlive/releases).
+
+Load the docker image:
+
+ cat ezlive-docker-image.tar.gz | gzip -d | sudo docker load
+
+Create a directory `conf`:
+
+ mkdir conf
+
+Create a config file `conf/config`, the config file is nearly the same as the config above. But for docker, the `listening_addr` should be `0.0.0.0`:
+
+ listening_addr=0.0.0.0
+ listening_port=1935
+ bucket=YOUR_BUCKET_NAME
+ endpoint=https://your-oss.com
+ s3_path=ezlive/
+ access_key=YOUR_S3_ACCESS_KEY
+ secret_key=YOUR_S3_SECRET_KEY
+ region=auto
+
+Start docker container:
+
+ sudo docker run -it --rm \
+ -v ./conf:/etc/ezlive/ \
+ -p 127.0.0.1:1935:1935 \
+ localhost/ezlive
+
# Credits
The built-in RTMP server is modified from [pine](https://github.com/deboot/pine).