feat(docs): document published Docker deployment
This commit is contained in:
二丫讲梵
GitHub
parent
996f4c2d38
commit
039b7b9c75
22
README.md
22
README.md
|
|
@ -46,6 +46,7 @@
|
|||
<img src="https://img.shields.io/badge/JDBC-4B5563?logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/and%20more...-555555?logoColor=white" />
|
||||
<a href="https://atomgit.com/t8y2/dbx"><img src="https://atomgit.com/t8y2/dbx/star/badge.svg" alt="AtomGit Stars" /></a>
|
||||
<a href="https://cnb.cool/dbxio.com/dbx"><img src="https://img.shields.io/badge/CNB-dbx-F76945?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAppJREFUOE9tk01rE1EUhs+5H5lJ0iQT3FRX2Yi4avoLkv4CWxBcNt11oZiuFKGmXQhFN6kuRESSgitXKf6A5g+I6cqFLiKCiptOkraZ5H4cuZOkH9oLw+UO8z7nvGfei3DFohoEQLAKCGWyGJCSbQZsD3ei7r+f45WATV6xmjdISyAlYLaDliveux+ti5ozwLAaFPhIlk6G6f18sxuO7l9bBiWbVoncDGCMWMl++PI/gJ7IohkmD0zkBxT5oRn5LTpN7ULqBByEtFywWvRyHz8Fx3dvN0UwuMPyR0uJFycddH7tKPHZRn7BjnwwkQcUud0HO/K7oOENcTYPRCEAFERmsCpyfZDZfpdnBosOUKGx13BC60QTIdjpmSzrEWDR+UagjsgMciLXAwfhc4MNpKfQtOPE6mVh0gEOaeTXtWXXEdADpJAR/GaZ/rrM9Us82wORPd5zHbRp7JVcyxR5PRP5LTPy6uo0HXIlG9awMgLuEUABkBYI7VLyxs+yyPW3+Nyg4zqoG+UV7TDRlMBbWA/D43u3qlbLGmgRWM2BjFxjQjWQGQBuu4bYYvrm14JMnQSXcjBcny9A5DXIiDJp9/8FWCXAAOaFUEfILTgIcttOvf+2NJnLdI0fBFUyskZKBGTEJEAmBuzr9LCSUDwGQAwwgMzu+m9/VWOAeZSsk+YP48C4li/sRok1nlBd5PogBjgxNw70PfHyqBADyEVXicasZXCVpxYiLfO+HxVZDHCVYwvu2ebPT7fOLNAm65AWLnEAzvsEcOi9/lPU1aACXDfOLdhD9kxNszGdweQGYstqXgItJwDFNxKvwrp57G8h0zVwldHuA0IFt8El83yIs2FSDcpgxDJpUUTwK7gTduN3AK5iG7ehc/E2/gUPD3q3eY4awwAAAABJRU5ErkJggg==" alt="CNB" /></a>
|
||||
</p>
|
||||
<p>
|
||||
English | <a href="README.zh-CN.md">前往中文版本</a>
|
||||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@
|
|||
<img src="https://img.shields.io/badge/JDBC-4B5563?logoColor=white" />
|
||||
<img src="https://img.shields.io/badge/and%20more...-555555?logoColor=white" />
|
||||
<a href="https://atomgit.com/t8y2/dbx"><img src="https://atomgit.com/t8y2/dbx/star/badge.svg" alt="AtomGit Stars" /></a>
|
||||
<a href="https://atomgit.com/t8y2/dbx"><img src="https://atomgit.com/t8y2/dbx/star/badge.svg" alt="AtomGit Stars" /></a>
|
||||
<a href="https://cnb.cool/dbxio.com/dbx"><img src="https://img.shields.io/badge/CNB-dbx-F76945?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAppJREFUOE9tk01rE1EUhs+5H5lJ0iQT3FRX2Yi4avoLkv4CWxBcNt11oZiuFKGmXQhFN6kuRESSgitXKf6A5g+I6cqFLiKCiptOkraZ5H4cuZOkH9oLw+UO8z7nvGfei3DFohoEQLAKCGWyGJCSbQZsD3ei7r+f45WATV6xmjdISyAlYLaDliveux+ti5ozwLAaFPhIlk6G6f18sxuO7l9bBiWbVoncDGCMWMl++PI/gJ7IohkmD0zkBxT5oRn5LTpN7ULqBByEtFywWvRyHz8Fx3dvN0UwuMPyR0uJFycddH7tKPHZRn7BjnwwkQcUud0HO/K7oOENcTYPRCEAFERmsCpyfZDZfpdnBosOUKGx13BC60QTIdjpmSzrEWDR+UagjsgMciLXAwfhc4MNpKfQtOPE6mVh0gEOaeTXtWXXEdADpJAR/GaZ/rrM9Us82wORPd5zHbRp7JVcyxR5PRP5LTPy6uo0HXIlG9awMgLuEUABkBYI7VLyxs+yyPW3+Nyg4zqoG+UV7TDRlMBbWA/D43u3qlbLGmgRWM2BjFxjQjWQGQBuu4bYYvrm14JMnQSXcjBcny9A5DXIiDJp9/8FWCXAAOaFUEfILTgIcttOvf+2NJnLdI0fBFUyskZKBGTEJEAmBuzr9LCSUDwGQAwwgMzu+m9/VWOAeZSsk+YP48C4li/sRok1nlBd5PogBjgxNw70PfHyqBADyEVXicasZXCVpxYiLfO+HxVZDHCVYwvu2ebPT7fOLNAm65AWLnEAzvsEcOi9/lPU1aACXDfOLdhD9kxNszGdweQGYstqXgItJwDFNxKvwrp57G8h0zVwldHuA0IFt8El83yIs2FSDcpgxDJpUUTwK7gTduN3AK5iG7ehc/E2/gUPD3q3eY4awwAAAABJRU5ErkJggg==" alt="CNB" /></a>
|
||||
</p>
|
||||
<p>
|
||||
<a href="README.md">English</a> | 简体中文
|
||||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
@ -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 卷或服务器数据目录 |
|
||||
|
||||
<Callout type="info">核心数据库能力保持一致，但通过 MCP 打开桌面窗口等集成需要 DBX 桌面版正在运行。</Callout>
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Reference in New Issue