Skip to content

Commit 3b5b94e

Browse files
committed
Docs: Update Docker image instructions for standard and bundled versions
1 parent cb4dd4d commit 3b5b94e

File tree

5 files changed

+83
-21
lines changed

5 files changed

+83
-21
lines changed

.github/workflows/docker-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ jobs:
114114
push: true
115115
tags: |
116116
ghcr.io/${{ github.repository }}/mcp-proxy-server:${{ steps.get_version.outputs.version }}-bundled-mcpservers-playwright
117-
ghcr.io/${{ github.repository }}/mcp-proxy-server:bundled-mcpservers-playwright-latest
117+
ghcr.io/${{ github.repository }}/mcp-proxy-server:latest-bundled-mcpservers-playwright
118118
build-args: |
119119
PRE_INSTALLED_PIP_PACKAGES_ARG=mcp-server-time markitdown-mcp mcp-proxy
120120
PRE_INSTALLED_NPM_PACKAGES_ARG=g-search-mcp fetcher-mcp playwright time-mcp mcp-trends-hub @adenot/mcp-google-search edgeone-pages-mcp @modelcontextprotocol/server-filesystem mcp-server-weibo @variflight-ai/variflight-mcp @baidumap/mcp-server-baidu-map @modelcontextprotocol/inspector

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,17 +188,49 @@ A `Dockerfile` is provided. The container runs the server in **SSE mode** by def
188188

189189
**Recommended: Using the Pre-built Image (from GHCR)**
190190

191-
It's recommended to use the pre-built image from GitHub Container Registry for easier setup.
191+
It's recommended to use the pre-built image from GitHub Container Registry for easier setup. We provide two types of images:
192192
193-
```bash
194-
# Pull the latest image
195-
docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:latest
193+
1. **Standard Image (Lean)**: This is the default and recommended image for most users. It contains the core MCP Proxy Server functionality.
194+
* Tags: `latest`, `<version>` (e.g., `0.1.2`)
195+
```bash
196+
# Pull the latest standard image
197+
docker pull ghcr.io/${{ github.repository }}/mcp-proxy-server:latest
196198
197-
# Or pull a specific version (e.g., v0.1.0)
198-
# docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:v0.1.0
199-
```
199+
# Or pull a specific version
200+
# docker pull ghcr.io/${{ github.repository }}/mcp-proxy-server:0.1.2
201+
```
202+
203+
2. **Bundled Image (Full-featured)**: This image includes a set of pre-installed MCP servers and Playwright browser dependencies. It's significantly larger but provides out-of-the-box access to common tools.
204+
* Tag: `<version>-bundled-mcpservers-playwright` (e.g., `0.1.2-bundled-mcpservers-playwright`) or latest-bundled-mcpservers-playwright
205+
```bash
206+
# Pull a bundled version
207+
# docker pull ghcr.io/${{ github.repository }}/mcp-proxy-server:latest-bundled-mcpservers-playwright
208+
```
200209

201-
Then, run the container using the pulled image name:
210+
The bundled image includes the following pre-installed components (via Docker build arguments):
211+
* **PIP Packages** (`PRE_INSTALLED_PIP_PACKAGES_ARG`):
212+
* `mcp-server-time`
213+
* `markitdown-mcp`
214+
* `mcp-proxy`
215+
* **NPM Packages** (`PRE_INSTALLED_NPM_PACKAGES_ARG`):
216+
* `g-search-mcp`
217+
* `fetcher-mcp`
218+
* `playwright`
219+
* `time-mcp`
220+
* `mcp-trends-hub`
221+
* `@adenot/mcp-google-search`
222+
* `edgeone-pages-mcp`
223+
* `@modelcontextprotocol/server-filesystem`
224+
* `mcp-server-weibo`
225+
* `@variflight-ai/variflight-mcp`
226+
* `@baidumap/mcp-server-baidu-map`
227+
* `@modelcontextprotocol/inspector`
228+
* **Initialization Command** (`PRE_INSTALLED_INIT_COMMAND_ARG`):
229+
* `playwright install --with-deps chromium`
230+
231+
Choose the image type that best suits your needs. For most users, the standard image is sufficient, and backend MCP servers can be configured via `mcp_server.json`.
232+
233+
Then, run your chosen container image:
202234

203235
```bash
204236
docker run -d \

README_ZH.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -191,17 +191,49 @@ npm run watch
191191

192192
**推荐:使用预构建镜像 (来自 GHCR)**
193193

194-
建议使用 GitHub Container Registry 上的预构建镜像以便于设置。
194+
建议使用 GitHub Container Registry 上的预构建镜像以便于设置。我们提供两种类型的镜像:
195195

196-
```bash
197-
# 拉取最新镜像
198-
docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:latest
196+
1. **标准版镜像 (精简版)**: 这是默认且为大多数用户推荐的镜像。它包含了 MCP 代理服务器的核心功能。
197+
* 标签: `latest`, `<version>` (例如, `0.1.2`)
198+
```bash
199+
# 拉取最新的标准版镜像
200+
docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:latest
199201
200-
# 或拉取特定版本 (例如 v0.1.0)
201-
# docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:v0.1.0
202-
```
202+
# 或拉取特定版本
203+
# docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:0.1.2
204+
```
205+
206+
2. **捆绑版镜像 (功能完整版)**: 此镜像包含了一组预安装的 MCP 服务器和 Playwright 浏览器依赖。它明显更大,但提供了对常用工具的开箱即用访问。
207+
* 标签: `<version>-bundled-mcpservers-playwright` (例如, `0.1.2-bundled-mcpservers-playwright`) 或 `latest-bundled-mcpservers-playwright`
208+
```bash
209+
# 拉取捆绑版镜像
210+
# docker pull ghcr.io/ptbsare/mcp-proxy-server/mcp-proxy-server:latest-bundled-mcpservers-playwright
211+
```
203212

204-
然后,使用拉取的镜像名称运行容器:
213+
捆绑版镜像通过 Docker 构建参数预装了以下组件:
214+
* **PIP 包** (`PRE_INSTALLED_PIP_PACKAGES_ARG`):
215+
* `mcp-server-time`
216+
* `markitdown-mcp`
217+
* `mcp-proxy`
218+
* **NPM 包** (`PRE_INSTALLED_NPM_PACKAGES_ARG`):
219+
* `g-search-mcp`
220+
* `fetcher-mcp`
221+
* `playwright`
222+
* `time-mcp`
223+
* `mcp-trends-hub`
224+
* `@adenot/mcp-google-search`
225+
* `edgeone-pages-mcp`
226+
* `@modelcontextprotocol/server-filesystem`
227+
* `mcp-server-weibo`
228+
* `@variflight-ai/variflight-mcp`
229+
* `@baidumap/mcp-server-baidu-map`
230+
* `@modelcontextprotocol/inspector`
231+
* **初始化命令** (`PRE_INSTALLED_INIT_COMMAND_ARG`):
232+
* `playwright install --with-deps chromium`
233+
234+
请根据您的需求选择合适的镜像类型。对于大多数用户,标准版镜像已足够,后端 MCP 服务器可以通过 `mcp_server.json` 进行配置。
235+
236+
然后,运行您选择的容器镜像:
205237

206238
```bash
207239
docker run -d \

config.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ image: "ghcr.io/ptbsare/home-assistant-addons/{arch}-addon-mcp-proxy-server" # V
3636
startup: application
3737
boot: auto
3838
webui: "http://[HOST]:[PORT:3663]/admin"
39-
ingress: true
40-
ingress_port: 3663
41-
ingress_entry: admin
39+
ingress: false
4240
panel_icon: "mdi:server-network-outline"
4341
panel_title: "MCP Proxy Server"

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mcp-proxy-server",
3-
"version": "0.1.6",
3+
"version": "0.1.7",
44
"author": "ptbsare",
55
"license": "MIT",
66
"description": "An MCP proxy server that aggregates and serves multiple MCP resource servers through a single interface with stdio/sse support",

0 commit comments

Comments
 (0)