Skip to content

Commit d08b1d4

Browse files
authored
docs: add Docker deployment instructions to README files (#161)
- Added a new section for deploying using Docker in both English and Chinese README files. - Included detailed steps for building the Docker image, starting services with Docker Compose, and configuration notes. - Updated the Docker README with important notes regarding image storage and local image usage.
1 parent 9fcc740 commit d08b1d4

File tree

3 files changed

+94
-5
lines changed

3 files changed

+94
-5
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,48 @@ go env -w GOPROXY=https://goproxy.io,direct
247247

248248
</details>
249249

250+
**方式三:使用 Docker 容器(最简单)**
251+
252+
<details>
253+
<summary>Docker 部署详情</summary>
254+
255+
使用 Docker 部署是最简单的方式,无需安装任何开发环境。
256+
257+
**1. 构建镜像**
258+
259+
```bash
260+
# 在项目根目录运行
261+
docker build -t xpzouying/xiaohongshu-mcp .
262+
```
263+
264+
**2. 使用 Docker Compose 启动**
265+
266+
```bash
267+
# 进入 docker 目录
268+
cd docker
269+
270+
# 启动服务
271+
docker compose up -d
272+
273+
# 查看日志
274+
docker compose logs -f
275+
276+
# 停止服务
277+
docker compose stop
278+
```
279+
280+
**3. 配置说明**
281+
282+
Docker 版本会自动:
283+
- 配置 Chrome 浏览器和中文字体
284+
- 挂载 `./data` 用于存储 cookies
285+
- 挂载 `./images` 用于存储发布的图片
286+
- 暴露 18060 端口供 MCP 连接
287+
288+
详细使用说明请参考:[Docker 部署指南](./docker/README.md)
289+
290+
</details>
291+
250292
Windows 遇到问题首先看这里:[Windows 安装指南](./docs/windows_guide.md)
251293

252294
### 1.2. 登录

README_EN.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,48 @@ go env -w GOPROXY=https://goproxy.io,direct
247247

248248
</details>
249249

250+
**Method 3: Using Docker Container (Simplest)**
251+
252+
<details>
253+
<summary>Docker Deployment Details</summary>
254+
255+
Using Docker deployment is the simplest method, requiring no development environment installation.
256+
257+
**1. Build Image**
258+
259+
```bash
260+
# Run in project root directory
261+
docker build -t xpzouying/xiaohongshu-mcp .
262+
```
263+
264+
**2. Start with Docker Compose**
265+
266+
```bash
267+
# Enter docker directory
268+
cd docker
269+
270+
# Start service
271+
docker compose up -d
272+
273+
# View logs
274+
docker compose logs -f
275+
276+
# Stop service
277+
docker compose stop
278+
```
279+
280+
**3. Configuration Notes**
281+
282+
The Docker version automatically:
283+
- Configures Chrome browser and Chinese fonts
284+
- Mounts `./data` for storing cookies
285+
- Mounts `./images` for storing publish images
286+
- Exposes port 18060 for MCP connection
287+
288+
For detailed instructions, please refer to: [Docker Deployment Guide](./docker/README.md)
289+
290+
</details>
291+
250292
For Windows issues, check here first: [Windows Installation Guide](./docs/windows_guide.md)
251293

252294
### 1.2. Login

docker/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
11
# Docker 使用说明
2-
<!-- TOC depthFrom:2 -->
32

4-
- [1. 自己构建镜像](#1-自己构建镜像)
5-
- [2. 手动 Docker Compose](#2-手动 Docker Compose)
3+
## 0. 重点注意
4+
5+
写在最前面。
6+
7+
- 启动后,会产生一个 `images/` 目录,用于存储发布的图片。它会挂载到 Docker 容器里面。
8+
如果要使用本地图片发布的话,请确保图片拷贝到 `./images/` 目录下,并且让 MCP 在发布的时候,指定文件夹为:`/app/images`,否则一定失败。
69

710
## 1. 自己构建镜像
811

912
可以使用源码自己构建镜像,如下:
1013

1114
在有项目的Dockerfile的目录运行
1215

13-
`docker build -t xpzouying/xiaohongshu-mcp .`
16+
```bash
17+
docker build -t xpzouying/xiaohongshu-mcp .
18+
```
1419

1520
`xpzouying/xiaohongshu-mcp`为镜像名称和版本。
1621

1722
<img width="2576" height="874" alt="image" src="https://github.com/user-attachments/assets/fe7e87f1-623f-409f-8b54-e11d380fc7b8" />
1823

1924
## 2. 手动 Docker Compose
2025

21-
```
26+
```bash
2227
# 注意:在 docker-compose.yml 文件的同一个目录,或者手动指定 docker-compose.yml。
2328

2429
# --- 启动 docker 容器 ---

0 commit comments

Comments
 (0)