feat(README): 修改README

Author: LLiuHuan

.github/workflows/docker-image.yml

@@ -56,7 +56,7 @@ jobs:
           [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
 
           # Use Docker `latest` tag convention
-          [ "$VERSION" == "master" ] && VERSION=latest
+          # [ "$VERSION" == "master" ] && VERSION=latest
 
           echo IMAGE_ID=$IMAGE_ID
           echo VERSION=$VERSION
@@ -70,3 +70,6 @@ jobs:
           docker buildx create --name multi-platform --use --platform linux/amd64,linux/arm64 --driver docker-container
           # 进行 push
           docker buildx build --platform linux/arm64,linux/arm64/v8,linux/ppc64le,linux/amd64,linux/386 -t $IMAGE_ID:$VERSION . --push
+          if [[ $VERSION != *"ffmpeg"* ]]; then
+            docker buildx build --platform linux/arm64,linux/arm64/v8,linux/ppc64le,linux/amd64,linux/386 -t $IMAGE_ID:latest . --push
+          fi

README-zh.md

@@ -2,28 +2,211 @@
  * @Description: 
  * @Author: LLiuHuan
  * @Date: 2022-04-11 16:30:02
- * @LastEditTime: 2024-07-11 15:15:36
+ * @LastEditTime: 2024-09-05 09:49:19
  * @LastEditors: LLiuHuan
 -->
 ### 介绍
-> nginx-http-flv-module官方镜像是四年前的，因项目需要弄个最新版  
+> nginx-http-flv-module官方镜像是N年前的，因项目需要弄个最新版  
 
 1. 本项目使用最新版 `nginx-http-flv-module` 目前版本为 `1.2.11`  
 2. rtmp和http nginx 解析都为 stream，有需要可自行修改
 
 ### 使用
 1. 运行容器  
-  `docker run --name flv -p 31935:1935 -p 39000:9000 -itd lliuhuan/nginx-http-flv-module`  
+  ```
+  docker run --name flv -p 1935:1935 -p 8080:80 -itd lliuhuan/nginx-http-flv-module
+  ```  
 2. 使用OBS或其他软件推送  
   ```
-  Server: rtmp://127.0.0.1:31935/stream
+  Server: rtmp://127.0.0.1:1935/stream
   Secret Key: t55
   ```  
   ![image](./static/1.OBS.gif)  
 3. 使用IINA或其他软件播放  
-  `http://127.0.0.1:39000/stream?app=stream&stream=t55`
+  ```
+  http://127.0.0.1:8080/stream?app=stream&stream=t55
+  ```
 ![image](./static/2.IINA.gif)  
 
+#### RTMP 方式
+
+##### 推流
+```bash
+# 服务
+rtmp://127.0.0.1:1935/[app]
+# streamname
+t55
+```
+##### 播放
+```
+http://127.0.0.1:8080/stream?app=stream&stream=[streamname]
+```
+
+#### HLS 方式
+##### 推流
+```bash
+# 服务
+rtmp://127.0.0.1:1935/hls
+# streamname
+t55
+```
+##### 播放
+```
+http://localhost:8080/hls/[streamname].m3u8
+```
+
+#### DASH 方式
+##### 推流
+```bash
+# 服务
+rtmp://127.0.0.1:1935/dash
+# streamname
+t55
+```
+##### 播放
+```
+http://localhost:8080/dash/[streamname].mpd
+```
+
+#### 监控
+```
+http://127.0.0.1:8080/stat
+```
+
+### 默认Nginx配置
+```nginx
+user  root;
+worker_processes  1; #运行在 Windows 上时，设置为 1，因为 Windows 不支持 Unix domain socket
+#worker_processes  auto; #1.3.8 和 1.2.5 以及之后的版本
+
+#worker_cpu_affinity  0001 0010 0100 1000; #只能用于 FreeBSD 和 Linux
+#worker_cpu_affinity  auto; #1.9.10 以及之后的版本
+
+error_log logs/error.log error;
+
+#如果此模块被编译为动态模块并且要使用与 RTMP 相关的功
+#能时，必须指定下面的配置项并且它必须位于 events 配置
+#项之前，否则 NGINX 启动时不会加载此模块或者加载失败
+
+#load_module modules/ngx_http_flv_live_module.so;
+
+# error_log  /var/log/nginx/error.log notice;
+# pid        /var/run/nginx.pid;
+
+events {
+    worker_connections  4096;  ## Default: 1024
+}
+
+rtmp_auto_push on;
+rtmp_auto_push_reconnect 1s;
+rtmp_socket_dir /tmp;
+
+rtmp {
+    out_queue           4096;
+    out_cork            8;
+    max_streams         128;
+    timeout             15s;
+    drop_idle_publisher 15s;
+
+    log_interval 5s; #log 模块在 access.log 中记录日志的间隔时间，对调试非常有用
+    log_size     1m; #log 模块用来记录日志的缓冲区大小
+
+    server {
+        listen 1935;  # 接受推流的端口号
+        chunk_size 8192; # 单一推流数据包的最大容量？
+        access_log off;	# 加上这行，取消操作日志
+        application stream { # mlive 模块，可以自行更换名字
+            live on; # 打开直播
+            meta off; # 为了兼容网页前端的 flv.js，设置为 off 可以避免报错
+            gop_cache on; # 支持GOP缓存，以减少首屏时间  改为off 延迟较大
+            allow play all; # 允许来自任何 ip 的人拉流
+        }
+
+        application hls { # hls 模块，可以自行更换名字
+            live on;
+            hls on;
+            hls_path /tmp/hls;
+        }
+
+        application dash { # dash 模块，可以自行更换名字
+            live on;
+            dash on;
+            dash_path /tmp/dash;
+        }
+    }
+}
+
+http {
+    include       mime.types;
+    default_type  application/octet-stream;
+    sendfile        on;
+    #tcp_nopush     on;
+    #keepalive_timeout  0;
+    keepalive_timeout  65;
+    #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+    #                  '$status $body_bytes_sent "$http_referer" '
+    #                  '"$http_user_agent" "$http_x_forwarded_for"';
+    #access_log  logs/access.log  main;
+    access_log off;	# 加上这行，取消操作日志
+    #gzip  on;
+    server {
+        listen       80;  # http 服务的端口
+        # server_name  localhost;
+        location / {
+            root   html;
+            index  index.html index.htm;
+            add_header 'Access-Control-Allow-Origin' '*'; # 允许跨域
+            add_header 'Access-Control-Allow-Credentials' 'true';
+        }
+
+        location /stream {
+            flv_live on; # 打开 http-flv 服务
+            chunked_transfer_encoding on; #支持 'Transfer-Encoding: chunked' 方式回复
+
+            add_header 'Access-Control-Allow-Origin' '*'; # 允许跨域
+            add_header 'Access-Control-Allow-Credentials' 'true';
+        }
+
+        location /hls { # hls 服务 根据需求修改
+            types {
+                application/vnd.apple.mpegurl m3u8;
+                video/mp2t ts;
+            }
+
+            root /tmp;
+            add_header 'Cache-Control' 'no-cache';
+        }
+
+        location /dash { # dash 服务 根据需求修改
+            root /tmp;
+            add_header 'Cache-Control' 'no-cache';
+        }
+
+        location /stat { # 推流播放和录制统计数据的配置 根据需求确定是否开放
+            rtmp_stat all;
+            rtmp_stat_stylesheet stat.xsl;
+        }
+
+        location /stat.xsl {
+            root rtmp; #指定 stat.xsl 的位置
+        }
+
+        #如果需要 JSON 风格的 stat, 不用指定 stat.xsl
+        #但是需要指定一个新的配置项 rtmp_stat_format
+        #location /stat {
+        #    rtmp_stat all;
+        #    rtmp_stat_format json;
+        #}
+
+        location /control {
+            rtmp_control all; #rtmp 控制模块的配置
+        }
+    }
+}
+
+```
+
+
 ### 通过工作流自动构建镜像
 当 push 标签为v* 时自动执行工作流,构建 Docker 镜像并上传到 Docker Hub