Northern_Lights/NapCat-Docker
1
0
Fork 0
mirror of https://github.com/NapNeko/NapCat-Docker.git synced 2025-12-18 22:06:41 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: update readme

Browse Source 
Signed-off-by: Sean Du <do4suki@gmail.com>
This commit is contained in:
Sean Du 2024-08-25 19:09:29 +08:00
parent 4394ad0dc0
commit 3c5b6978a3
7 changed files with 83 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
README.md
View File

@ -16,6 +16,8 @@
## 正向 WS
### 命令行运行
```shell
docker run -d \
-e ACCOUNT=<机器人qq> \
@ -28,42 +30,93 @@ docker run -d \
--restart=always \
mlikiowa/napcat-docker:latest
```
[docker compose 正向 WS](./docker-compose/ws)
### docker-compose 运行
使用以下命令生成 `.env` 文件
```shell
echo "NAPCAT_UID=$(id -u)" > .env
echo "NAPCAT_GID=$(id -g)" >> .env
```
创建 `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
```
使用 `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
```
使用 `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 +124,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
```
使用 `docker-compose up -d` 运行到后台
</details>
# 固化路径，方便下次直接快速登录
@ -91,4 +167,4 @@ docker logs napcat
# Tips
- 若 Docker 镜像拉取失败，可以使用 [Docker 镜像加速服务](https://github.com/dqzboy/Docker-Proxy)
- 若 Docker 镜像拉取失败，可以使用 [Docker 镜像加速服务](https://github.com/dqzboy/Docker-Proxy)

2
docker-compose/http/.env
View File

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

17
docker-compose/http/docker-compose.yml
View File

@ -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

2
docker-compose/we-reverse/.env
View File

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

15
docker-compose/we-reverse/docker-compose.yml
View File

@ -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

2
docker-compose/ws/.env
View File

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

15
docker-compose/ws/docker-compose.yml
View File

@ -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