mirror of
https://github.com/t8y2/dbx.git
synced 2026-10-19 16:16:45 +00:00
feat(docs): add 1Panel deployment guide
This commit is contained in:
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: 通过 1Panel 部署 DBX
|
||||
description: 使用 1Panel 应用商店安装、访问和更新 DBX Web 版。
|
||||
---
|
||||
|
||||
1Panel 应用商店提供了 DBX 官方 Docker 镜像,可以直接在服务器上完成安装和更新,不需要手动编写 Docker 命令。
|
||||
|
||||
## 安装 DBX
|
||||
|
||||
1. 登录 1Panel,打开 **应用商店**。
|
||||
2. 搜索 `DBX`,选择 DBX 官方应用。
|
||||
3. 选择要安装的版本,点击 **安装**。
|
||||
4. 在安装表单中确认以下配置:
|
||||
|
||||
| 配置项 | 默认值 | 说明 |
|
||||
| --- | --- | --- |
|
||||
| 端口 | `4224` | 服务器对外提供 DBX Web 访问的端口。若该端口已被占用,请改为其他未使用端口。 |
|
||||
| 访问密码 | 自动生成 | 打开 DBX Web 版时使用的登录密码。1Panel 会按 `random: true` 规则生成默认值,也可以在安装时修改。 |
|
||||
|
||||
5. 点击 **确定**,等待 1Panel 拉取镜像并启动容器。
|
||||
|
||||
<Callout type="info">
|
||||
访问密码不是数据库密码,而是 DBX Web 版的登录密码。请保存安装时设置或生成的密码。
|
||||
</Callout>
|
||||
|
||||
## 访问 DBX
|
||||
|
||||
安装完成后,在浏览器中打开:
|
||||
|
||||
```text
|
||||
http://服务器 IP:端口
|
||||
```
|
||||
|
||||
例如端口保持默认值时:
|
||||
|
||||
```text
|
||||
http://192.168.1.100:4224
|
||||
```
|
||||
|
||||
在登录页面输入安装时设置的 **访问密码**。如果无法访问,请依次检查:
|
||||
|
||||
- 1Panel 中 DBX 应用是否显示为运行中;
|
||||
- 浏览器地址中的端口是否与安装表单中的端口一致;
|
||||
- 云服务器安全组和系统防火墙是否允许该端口;
|
||||
- 端口是否被其他服务占用。
|
||||
|
||||
## 持久化与更新
|
||||
|
||||
DBX 的应用数据保存在 1Panel 应用目录的 `data` 目录,并挂载到容器内的 `/app/data`。重启容器或更新 DBX 时,连接配置和其他应用数据会继续保留。
|
||||
|
||||
更新时,在 1Panel 的 **已安装** 应用中打开 DBX,选择可用的新版本并执行更新。更新前建议先确认数据目录已经纳入服务器备份。
|
||||
|
||||
<Callout type="warn">
|
||||
不要直接删除 DBX 的应用数据目录,否则会同时删除已保存的连接配置和其他本地数据。卸载应用前请先完成备份。
|
||||
</Callout>
|
||||
|
||||
## 连接数据库
|
||||
|
||||
登录 DBX 后,点击 **新建连接**,填写目标数据库的类型、地址、端口、用户名和数据库密码。运行在 1Panel 服务器上的 DBX 容器必须能够访问目标数据库:
|
||||
|
||||
- 如果数据库也运行在同一台服务器上,使用服务器可访问的地址和端口;
|
||||
- 如果数据库运行在同一个 Docker 网络中,使用数据库容器名和容器端口;
|
||||
- 如果数据库位于内网,确保 1Panel 服务器已经接入对应网络,或按需配置 [SSH 隧道](/cn/docs/ssh-tunnel)。
|
||||
|
||||
<Callout type="info">
|
||||
`4224` 是 DBX Web 服务端口,不是目标数据库端口。连接数据库时仍需填写 MySQL、PostgreSQL、Redis 等目标数据库自身的端口。
|
||||
</Callout>
|
||||
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Deploy DBX with 1Panel
|
||||
description: Install, access, and update the DBX web edition from the 1Panel app store.
|
||||
---
|
||||
|
||||
The 1Panel app store provides the official DBX Docker image, so you can install and update the DBX web edition without writing Docker commands manually.
|
||||
|
||||
## Install DBX
|
||||
|
||||
1. Sign in to 1Panel and open **App Store**.
|
||||
2. Search for `DBX` and select the official DBX app.
|
||||
3. Select the version to install and click **Install**.
|
||||
4. Review the installation fields:
|
||||
|
||||
| Setting | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| Port | `4224` | The host port used to access DBX Web. Change it if the port is already in use. |
|
||||
| Access Password | Automatically generated | The password used to sign in to DBX Web. 1Panel generates the default value according to `random: true`, and you can change it during installation. |
|
||||
|
||||
5. Click **Confirm** and wait for 1Panel to pull the image and start the container.
|
||||
|
||||
<Callout type="info">
|
||||
The access password is the DBX Web login password, not a database password. Save the password shown or entered during installation.
|
||||
</Callout>
|
||||
|
||||
## Open DBX
|
||||
|
||||
After installation, open the following address in a browser:
|
||||
|
||||
```text
|
||||
http://SERVER_IP:PORT
|
||||
```
|
||||
|
||||
For example, when using the default port:
|
||||
|
||||
```text
|
||||
http://192.168.1.100:4224
|
||||
```
|
||||
|
||||
Enter the **Access Password** from the installation form. If the page does not open, check that:
|
||||
|
||||
- the DBX app is running in 1Panel;
|
||||
- the browser port matches the port in the installation form;
|
||||
- the cloud security group and host firewall allow that port;
|
||||
- the port is not already used by another service.
|
||||
|
||||
## Persistence and updates
|
||||
|
||||
DBX application data is stored in the 1Panel app directory's `data` directory and mounted at `/app/data` inside the container. Restarting or updating the container preserves saved connections and other application data.
|
||||
|
||||
To update DBX, open it under **Installed** apps in 1Panel, select an available version, and start the update. Confirm that the data directory is included in your server backup before updating.
|
||||
|
||||
<Callout type="warn">
|
||||
Do not delete DBX's application data directory unless you intend to remove saved connections and other local data. Back up the directory before uninstalling the app.
|
||||
</Callout>
|
||||
|
||||
## Connect to a database
|
||||
|
||||
After signing in, click **New Connection** and enter the target database type, address, port, username, and database password. The DBX container must be able to reach the target database:
|
||||
|
||||
- For a database on the same server, use an address and port reachable from that server.
|
||||
- For a database on the same Docker network, use its container name and container port.
|
||||
- For a private-network database, connect the 1Panel server to that network or configure an [SSH tunnel](/en/docs/ssh-tunnel) as needed.
|
||||
|
||||
<Callout type="info">
|
||||
`4224` is the DBX Web service port, not the target database port. Enter the database's own port when creating a MySQL, PostgreSQL, Redis, or other connection.
|
||||
</Callout>
|
||||
@@ -5,6 +5,7 @@
|
||||
"what-is-dbx",
|
||||
"changelog",
|
||||
"getting-started",
|
||||
"1panel",
|
||||
"databases",
|
||||
"---Core Features---",
|
||||
"query-editor",
|
||||
|
||||
Reference in New Issue
Block a user