Merge pull request #31 from YumeMichi/main

chore: update readme

README.md

@@ -16,6 +16,8 @@
 
 ## 正向 WS
 
+### 命令行运行
+
 ```shell
 docker run -d \
 -e ACCOUNT=<机器人qq> \
@@ -28,42 +30,87 @@ docker run -d \
 --restart=always \
 mlikiowa/napcat-docker:latest
 ```
-[docker compose 正向 WS](./docker-compose/ws)
 
+### docker-compose 运行
+
+创建 `docker-compose.yml` 文件
+```yaml
+# docker-compose.yml
+version: "3"
+services:
+    napcat:
+        environment:
+            - ACCOUNT=<机器人qq>
+            - WS_ENABLE=true
+            - NAPCAT_UID=${NAPCAT_UID}
+            - NAPCAT_GID=${NAPCAT_GID}
+        ports:
+            - 3001:3001
+            - 6099:6099
+        container_name: napcat
+        network_mode: bridge
+        restart: always
+        image: mlikiowa/napcat-docker:latest
+```
+
+使用 `NAPCAT_UID=$(id -u); NAPCAT_GID=$(id -g); docker-compose up -d` 运行到后台
 
 ## 反向 WS
 <details>
 <summary>点我查看命令👈</summary>
 
+### 命令行运行
+
 ```shell
 docker run -d \
 -e ACCOUNT=<机器人qq> \
 -e WSR_ENABLE=true \
+-e WS_URLS='["ws://192.168.3.8:5140/onebot"]' \
 -e NAPCAT_GID=$(id -g) \
 -e NAPCAT_UID=$(id -u) \
--e WS_URLS='["ws://192.168.3.8:5140/onebot"]' \
 --name napcat \
 --restart=always \
 mlikiowa/napcat-docker:latest
 ```
+### docker-compose 运行
 
-[docker compose 反向 WS](./docker-compose/we-reverse)
+按照 [正向 WS](#docker-compose-运行) 中的方式创建 `.env` 文件，然后创建 `docker-compose.yml` 文件
-
+```yaml
+# docker-compose.yml
+version: "3"
+services:
+    napcat:
+        environment:
+            - ACCOUNT=<机器人qq>
+            - WSR_ENABLE=true
+            - WS_URLS=["ws://192.168.3.8:5140/onebot"]
+            - NAPCAT_UID=${NAPCAT_UID}
+            - NAPCAT_GID=${NAPCAT_GID}
+        container_name: napcat
+        network_mode: bridge
+        ports:
+           - 6099:6099
+        restart: always
+        image: mlikiowa/napcat-docker:latest
+```
 
+使用 `NAPCAT_UID=$(id -u); NAPCAT_GID=$(id -g); docker-compose up -d` 运行到后台
 </details>
 
 ## HTTP
 <details>
 <summary>点我查看命令👈</summary>
 
+### 命令行运行
+
 ```shell
 docker run -d \
 -e ACCOUNT=<机器人qq> \
 -e HTTP_ENABLE=true \
 -e HTTP_POST_ENABLE=true \
+-e HTTP_URLS='["http://192.168.3.8:5140/onebot"]' \
 -e NAPCAT_GID=$(id -g) \
 -e NAPCAT_UID=$(id -u) \
--e HTTP_URLS='["http://192.168.3.8:5140/onebot"]' \
 -p 3000:3000 \
 -p 6099:6099 \
 --name napcat \
@@ -71,8 +118,31 @@ docker run -d \
 mlikiowa/napcat-docker:latest
 ```
 
-[docker compose HTTP POST](./docker-compose/http)
+### docker-compose 运行
 
+按照 [正向 WS](#docker-compose-运行) 中的方式创建 `.env` 文件，然后创建 `docker-compose.yml` 文件
+```yaml
+# docker-compose.yml
+version: "3"
+services:
+    napcat:
+        environment:
+            - ACCOUNT=<机器人qq>
+            - HTTP_ENABLE=true
+            - HTTP_POST_ENABLE=true
+            - HTTP_URLS=["http://192.168.3.8:5140/onebot"]
+            - NAPCAT_UID=${NAPCAT_UID}
+            - NAPCAT_GID=${NAPCAT_GID}
+        ports:
+            - 3000:3000
+            - 6099:6099
+        container_name: napcat
+        network_mode: bridge
+        restart: always
+        image: mlikiowa/napcat-docker:latest
+```
+
+使用 `NAPCAT_UID=$(id -u); NAPCAT_GID=$(id -g); docker-compose up -d` 运行到后台
 </details>
 
 # 固化路径，方便下次直接快速登录
@@ -91,4 +161,4 @@ docker logs napcat
 
 # Tips
 
-- 若 Docker 镜像拉取失败，可以使用 [Docker 镜像加速服务](https://github.com/dqzboy/Docker-Proxy) 
+- 若 Docker 镜像拉取失败，可以使用 [Docker 镜像加速服务](https://github.com/dqzboy/Docker-Proxy) 

docker-compose/http/.env

@@ -1,2 +0,0 @@
-NAPCAT_UID=$(id -u)
-NAPCAT_GID=$(id -g)

docker-compose/http/docker-compose.yml

@@ -1,17 +0,0 @@
-version: "3"
-services:
-    napcat:
-        environment:
-            - ACCOUNT=<机器人qq>
-            - HTTP_ENABLE=true
-            - HTTP_POST_ENABLE=true
-            - HTTP_URLS=["http://192.168.3.8:5140/onebot"]
-            - NAPCAT_UID=${NAPCAT_UID}
-            - NAPCAT_GID=${NAPCAT_GID}
-        ports:
-            - 3000:3000
-            - 6099:6099
-        container_name: napcat
-        network_mode: bridge
-        restart: always
-        image: mlikiowa/napcat-docker:latest

docker-compose/we-reverse/.env

@@ -1,2 +0,0 @@
-NAPCAT_UID=$(id -u)
-NAPCAT_GID=$(id -g)

docker-compose/we-reverse/docker-compose.yml

@@ -1,15 +0,0 @@
-version: "3"
-services:
-    napcat:
-        environment:
-            - ACCOUNT=<机器人qq>
-            - WSR_ENABLE=true
-            - WS_URLS=["ws://192.168.3.8:5140/onebot"]
-            - NAPCAT_UID=${NAPCAT_UID}
-            - NAPCAT_GID=${NAPCAT_GID}
-        container_name: napcat
-        network_mode: bridge
-        ports:
-           - 6099:6099
-        restart: always
-        image: mlikiowa/napcat-docker:latest

docker-compose/ws/.env

@@ -1,2 +0,0 @@
-NAPCAT_UID=$(id -u)
-NAPCAT_GID=$(id -g)

docker-compose/ws/docker-compose.yml

@@ -1,15 +0,0 @@
-version: "3"
-services:
-    napcat:
-        environment:
-            - ACCOUNT=<机器人qq>
-            - WS_ENABLE=true
-            - NAPCAT_UID=${NAPCAT_UID}
-            - NAPCAT_GID=${NAPCAT_GID}
-        ports:
-            - 3001:3001
-            - 6099:6099
-        container_name: napcat
-        network_mode: bridge
-        restart: always
-        image: mlikiowa/napcat-docker:latest