diff --git a/README.md b/README.md index 60b45fe22..36fe8b0ac 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ AtomGit Stars + CNB

English | 前往中文版本 @@ -214,18 +215,31 @@ winget install t8y2.dbx ## Self-Hosted (Docker) -DBX provides a web version that can be deployed via Docker. +DBX provides a web version that can be deployed via Docker. The examples use +the `latest` tag to pull the current release. ```bash -docker run -d --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx +docker run -d --pull=always --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx:latest ``` -Or with Docker Compose. A ready-to-use example lives at `deploy/docker-compose.yml`: +This uses the cross-platform `dbx-data` named volume. Users in China can use +the CNB image, `docker.cnb.cool/dbxio.com/dbx:latest`, for faster pulls. + +For Docker Compose, `deploy/docker-compose.yml` remains the source-build +configuration. To deploy a published image, use +`deploy/docker-compose.release.yml`: + +```bash +docker compose -f deploy/docker-compose.release.yml up -d +``` ```yaml services: dbx: - image: t8y2/dbx + image: t8y2/dbx:latest + # For faster pulls in China, use the CNB image instead: + # image: docker.cnb.cool/dbxio.com/dbx:latest + pull_policy: always ports: - "4224:4224" volumes: diff --git a/README.zh-CN.md b/README.zh-CN.md index 87ae97856..5cae3f248 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -46,7 +46,7 @@ AtomGit Stars - AtomGit Stars + CNB

English | 简体中文 @@ -215,18 +215,29 @@ winget install t8y2.dbx ## 自托管 (Docker) -DBX 提供 Web 版本,可通过 Docker 部署。 +DBX 提供 Web 版本,可通过 Docker 部署。示例使用 `latest` 标签以拉取当前发布版本。 ```bash -docker run -d --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx +docker run -d --pull=always --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx:latest ``` -或使用 Docker Compose,示例文件位于 `deploy/docker-compose.yml`: +这里使用跨平台的 `dbx-data` 命名卷。中国大陆用户可选用 CNB 镜像 +`docker.cnb.cool/dbxio.com/dbx:latest`,以获得更快的拉取速度。 + +使用 Docker Compose 时,`deploy/docker-compose.yml` 保留为源码构建配置。 +如需部署已发布的镜像,请使用 `deploy/docker-compose.release.yml`: + +```bash +docker compose -f deploy/docker-compose.release.yml up -d +``` ```yaml services: dbx: - image: t8y2/dbx + image: t8y2/dbx:latest + # 中国大陆用户可改用 CNB 镜像,以加快拉取速度: + # image: docker.cnb.cool/dbxio.com/dbx:latest + pull_policy: always ports: - "4224:4224" volumes: diff --git a/deploy/docker-compose.release.yml b/deploy/docker-compose.release.yml new file mode 100644 index 000000000..1e8430cad --- /dev/null +++ b/deploy/docker-compose.release.yml @@ -0,0 +1,14 @@ +services: + dbx: + image: t8y2/dbx:latest + # For faster pulls in China, use the CNB image instead: + # image: docker.cnb.cool/dbxio.com/dbx:latest + pull_policy: always + ports: + - "4224:4224" + volumes: + - dbx-data:/app/data + restart: unless-stopped + +volumes: + dbx-data: diff --git a/docs/content/docs/getting-started.cn.mdx b/docs/content/docs/getting-started.cn.mdx index 926a43e92..f2d2eca3e 100644 --- a/docs/content/docs/getting-started.cn.mdx +++ b/docs/content/docs/getting-started.cn.mdx @@ -65,20 +65,30 @@ description: 安装 DBX、创建第一个连接,并了解桌面版、Docker ```bash docker run -d \ + --pull=always \ --name dbx \ -p 4224:4224 \ -v dbx-data:/app/data \ - t8y2/dbx + t8y2/dbx:latest ``` + `latest` 标签会拉取当前发布版本。这里使用跨平台的 `dbx-data` 命名卷;中国大陆用户可改用 `docker.cnb.cool/dbxio.com/dbx:latest`,以获得更快的拉取速度。 + 启动后访问 `http://localhost:4224`。 - Docker Compose: + `deploy/docker-compose.yml` 用于构建当前源码。若要部署已发布镜像,请使用 `deploy/docker-compose.release.yml`: + + ```bash + docker compose -f deploy/docker-compose.release.yml up -d + ``` ```yaml services: dbx: - image: t8y2/dbx + image: t8y2/dbx:latest + # 中国大陆用户可改用 CNB 镜像,以加快拉取速度: + # image: docker.cnb.cool/dbxio.com/dbx:latest + pull_policy: always ports: - "4224:4224" volumes: @@ -97,7 +107,7 @@ description: 安装 DBX、创建第一个连接,并了解桌面版、Docker | 模式 | 适合场景 | 后端路径 | 存储位置 | | ------------ | ------------------------------------------------------ | ----------------------------- | ------------------------------ | | 桌面版 | 本机日常工作、本地文件、原生窗口、从 MCP 打开 DBX 界面 | Tauri 命令调用 Rust core | 本机应用数据目录 | -| Docker / Web | 服务器自托管、浏览器访问 | HTTP 路由调用同一套 Rust core | Docker volume 或服务器数据目录 | +| Docker / Web | 服务器自托管、浏览器访问 | HTTP 路由调用同一套 Rust core | Docker 卷或服务器数据目录 | 核心数据库能力保持一致,但通过 MCP 打开桌面窗口等集成需要 DBX 桌面版正在运行。 diff --git a/docs/content/docs/getting-started.mdx b/docs/content/docs/getting-started.mdx index 3c3c7ad38..3df4cfb35 100644 --- a/docs/content/docs/getting-started.mdx +++ b/docs/content/docs/getting-started.mdx @@ -65,20 +65,30 @@ This guide gets you through three things: ```bash docker run -d \ + --pull=always \ --name dbx \ -p 4224:4224 \ -v dbx-data:/app/data \ - t8y2/dbx + t8y2/dbx:latest ``` + The `latest` tag pulls the current release. This uses the cross-platform `dbx-data` named volume. For faster pulls in China, use `docker.cnb.cool/dbxio.com/dbx:latest` instead. + Then open `http://localhost:4224`. - Docker Compose: + `deploy/docker-compose.yml` builds the current checkout. To deploy a published image, use `deploy/docker-compose.release.yml`: + + ```bash + docker compose -f deploy/docker-compose.release.yml up -d + ``` ```yaml services: dbx: - image: t8y2/dbx + image: t8y2/dbx:latest + # For faster pulls in China, use the CNB image instead: + # image: docker.cnb.cool/dbxio.com/dbx:latest + pull_policy: always ports: - "4224:4224" volumes: