From a7b4b536395677d26709122a6a3a9b977c107b25 Mon Sep 17 00:00:00 2001 From: Your Name Date: Tue, 18 Nov 2025 22:47:46 +0800 Subject: [PATCH] chore: update docker run docs --- docs/deployment/docker-compose.md | 22 ++++----- docs/deployment/docker.md | 74 +++++++++++++++---------------- 2 files changed, 49 insertions(+), 47 deletions(-) diff --git a/docs/deployment/docker-compose.md b/docs/deployment/docker-compose.md index 1086bcc..7986dbd 100644 --- a/docs/deployment/docker-compose.md +++ b/docs/deployment/docker-compose.md @@ -19,9 +19,9 @@ version: "3.7" services: message-nest: - image: engigu/message-nest:latest - # 或使用 GHCR 镜像 - # image: ghcr.io/engigu/message-nest:latest + image: ghcr.io/engigu/message-nest:latest + # 或使用 Docker Hub 镜像 + # image: engigu/message-nest:latest container_name: message-nest restart: always volumes: @@ -60,9 +60,9 @@ version: "3.7" services: message-nest: - image: engigu/message-nest:latest - # 或使用 GHCR 镜像 - # image: ghcr.io/engigu/message-nest:latest + image: ghcr.io/engigu/message-nest:latest + # 或使用 Docker Hub 镜像 + # image: engigu/message-nest:latest container_name: message-nest restart: always ports: @@ -85,9 +85,9 @@ version: "3.7" services: message-nest: - image: engigu/message-nest:latest - # 或使用 GHCR 镜像 - # image: ghcr.io/engigu/message-nest:latest + image: ghcr.io/engigu/message-nest:latest + # 或使用 Docker Hub 镜像 + # image: engigu/message-nest:latest container_name: message-nest restart: always ports: @@ -124,7 +124,9 @@ services: - "3306:3306" message-nest: - image: engigu/message-nest:latest + image: ghcr.io/engigu/message-nest:latest + # 或使用 Docker Hub 镜像 + # image: engigu/message-nest:latest container_name: message-nest restart: always depends_on: diff --git a/docs/deployment/docker.md b/docs/deployment/docker.md index 490eb79..c91b42c 100644 --- a/docs/deployment/docker.md +++ b/docs/deployment/docker.md @@ -10,8 +10,8 @@ Message Nest 提供两个镜像源: -- **Docker Hub**: `engigu/message-nest:latest` -- **GitHub Container Registry**: `ghcr.io/engigu/message-nest:latest` +- **GitHub Container Registry (推荐)**: `ghcr.io/engigu/message-nest:latest` +- **Docker Hub (备选)**: `engigu/message-nest:latest` ## 方式一:挂载配置文件 @@ -54,39 +54,39 @@ Docker模式下,配置文件中的端口只能为8000,通过 `-p` 参数映 ### 2. 拉取镜像 ```bash -# 从 Docker Hub 拉取 -docker pull engigu/message-nest:latest - -# 或从 GitHub Container Registry (GHCR) 拉取 +# 从 GitHub Container Registry (GHCR) 拉取(推荐) docker pull ghcr.io/engigu/message-nest:latest + +# 或从 Docker Hub 拉取 +docker pull engigu/message-nest:latest ``` ### 3. 启动容器 ```bash +# 测试运行(GHCR 镜像,推荐) +docker run --rm -ti \ + -p 8000:8000 \ + -v /your/path/conf:/app/conf \ + ghcr.io/engigu/message-nest:latest + # 测试运行(Docker Hub 镜像) docker run --rm -ti \ -p 8000:8000 \ -v /your/path/conf:/app/conf \ engigu/message-nest:latest - -# 测试运行(GHCR 镜像) -docker run --rm -ti \ + +# 正式运行(GHCR 镜像,推荐) +docker run -d \ -p 8000:8000 \ -v /your/path/conf:/app/conf \ ghcr.io/engigu/message-nest:latest - + # 正式运行(Docker Hub 镜像) docker run -d \ -p 8000:8000 \ -v /your/path/conf:/app/conf \ engigu/message-nest:latest - -# 正式运行(GHCR 镜像) -docker run -d \ - -p 8000:8000 \ - -v /your/path/conf:/app/conf \ - ghcr.io/engigu/message-nest:latest ``` ## 方式二:环境变量(推荐) @@ -115,19 +115,7 @@ docker run -d \ ### 使用 MySQL ```bash -# 正式运行(mysql) -docker run -d \ - -p 8000:8000 \ - -e MYSQL_HOST=192.168.64.133 \ - -e MYSQL_PORT=3308 \ - -e MYSQL_USER=root \ - -e MYSQL_PASSWORD=Aa123456 \ - -e MYSQL_DB=test_11 \ - -e MYSQL_TABLE_PREFIX=message_ \ - --name message-nest \ - engigu/message-nest:latest - -# 或使用 GHCR 镜像(mysql) +# 正式运行(GHCR 镜像,推荐) docker run -d \ -p 8000:8000 \ -e MYSQL_HOST=192.168.64.133 \ @@ -138,24 +126,36 @@ docker run -d \ -e MYSQL_TABLE_PREFIX=message_ \ --name message-nest \ ghcr.io/engigu/message-nest:latest + +# 或使用 Docker Hub 镜像 +docker run -d \ + -p 8000:8000 \ + -e MYSQL_HOST=192.168.64.133 \ + -e MYSQL_PORT=3308 \ + -e MYSQL_USER=root \ + -e MYSQL_PASSWORD=Aa123456 \ + -e MYSQL_DB=test_11 \ + -e MYSQL_TABLE_PREFIX=message_ \ + --name message-nest \ + engigu/message-nest:latest ``` ### 使用 SQLite ```bash -# 正式运行(sqlite) -docker run -d \ - -p 8000:8000 \ - -v /your/path/database.db:/app/conf/database.db \ - --name message-nest \ - engigu/message-nest:latest - -# 或使用 GHCR 镜像(sqlite) +# 正式运行(GHCR 镜像,推荐) docker run -d \ -p 8000:8000 \ -v /your/path/database.db:/app/conf/database.db \ --name message-nest \ ghcr.io/engigu/message-nest:latest + +# 或使用 Docker Hub 镜像 +docker run -d \ + -p 8000:8000 \ + -v /your/path/database.db:/app/conf/database.db \ + --name message-nest \ + engigu/message-nest:latest ``` ## 访问服务