mirror of
https://github.com/t8y2/dbx.git
synced 2026-10-20 00:17:44 +00:00
docs: fix step headings in cloud sync pages
This commit is contained in:
dadong
@@ -38,10 +38,26 @@ DBX 可以把连接配置、界面设置和保存的 SQL 组成一个快照。
|
||||
[打开 GitHub Fine-grained token 创建页面](https://github.com/settings/personal-access-tokens/new)
|
||||
|
||||
<Steps>
|
||||
<Step>### 打开令牌设置 登录 GitHub，进入 **Settings → Developer settings → Personal access tokens → Fine-grained tokens**。</Step>
|
||||
<Step>### 创建令牌 点击 **Generate new token**，设置名称和有效期。</Step>
|
||||
<Step>### 设置权限 在 **Account permissions** 中找到 **Gists**，选择 **Read and write**。不需要授予仓库权限。</Step>
|
||||
<Step>### 保存令牌 创建后立即复制令牌。GitHub 只会完整显示一次。</Step>
|
||||
<Step>
|
||||
### 打开令牌设置
|
||||
|
||||
登录 GitHub，进入 **Settings → Developer settings → Personal access tokens → Fine-grained tokens**。
|
||||
</Step>
|
||||
<Step>
|
||||
### 创建令牌
|
||||
|
||||
点击 **Generate new token**，设置名称和有效期。
|
||||
</Step>
|
||||
<Step>
|
||||
### 设置权限
|
||||
|
||||
在 **Account permissions** 中找到 **Gists**，选择 **Read and write**。不需要授予仓库权限。
|
||||
</Step>
|
||||
<Step>
|
||||
### 保存令牌
|
||||
|
||||
创建后立即复制令牌。GitHub 只会完整显示一次。
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
也可以使用 Classic token，但只应勾选 `gist` scope，不要授予无关权限。
|
||||
@@ -49,9 +65,21 @@ DBX 可以把连接配置、界面设置和保存的 SQL 组成一个快照。
|
||||
### 首次上传
|
||||
|
||||
<Steps>
|
||||
<Step>### 选择平台 打开 **设置 → 同步 → GitHub / Gitee**，平台选择 **GitHub Gist**。</Step>
|
||||
<Step>### 填写令牌 将访问令牌粘贴到 **访问令牌**。建议勾选 **加密保存在本机**。</Step>
|
||||
<Step>### 创建 Gist 将 **代码片段 ID** 留空，点击 **上传**。DBX 会创建私有 Gist，并自动保存返回的 ID。</Step>
|
||||
<Step>
|
||||
### 选择平台
|
||||
|
||||
打开 **设置 → 同步 → GitHub / Gitee**，平台选择 **GitHub Gist**。
|
||||
</Step>
|
||||
<Step>
|
||||
### 填写令牌
|
||||
|
||||
将访问令牌粘贴到 **访问令牌**。建议勾选 **加密保存在本机**。
|
||||
</Step>
|
||||
<Step>
|
||||
### 创建 Gist
|
||||
|
||||
将 **代码片段 ID** 留空，点击 **上传**。DBX 会创建私有 Gist，并自动保存返回的 ID。
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
DBX 会在 Gist 中保存一个经过**代码片段加密密码**加密的 `dbx-sync.json` 文件。该密码保护完整快照，片段链接本身不会暴露连接信息、SQL 或设置；历史明文片段仍可下载一次以便迁移。
|
||||
@@ -74,10 +102,26 @@ DBX 会在 Gist 中保存一个经过**代码片段加密密码**加密的 `dbx-
|
||||
[打开 Gitee 私人令牌页面](https://gitee.com/profile/personal_access_tokens)
|
||||
|
||||
<Steps>
|
||||
<Step>### 打开私人令牌页面 登录 Gitee，进入 **设置 → 私人令牌**。</Step>
|
||||
<Step>### 生成新令牌 点击 **生成新令牌**，填写描述。</Step>
|
||||
<Step>### 设置权限 只勾选代码片段（`gists`）相关权限。如果界面只提供合并权限，选择能够读写代码片段的最小权限。</Step>
|
||||
<Step>### 保存令牌 生成后立即复制令牌，并存放在密码管理器中。</Step>
|
||||
<Step>
|
||||
### 打开私人令牌页面
|
||||
|
||||
登录 Gitee，进入 **设置 → 私人令牌**。
|
||||
</Step>
|
||||
<Step>
|
||||
### 生成新令牌
|
||||
|
||||
点击 **生成新令牌**，填写描述。
|
||||
</Step>
|
||||
<Step>
|
||||
### 设置权限
|
||||
|
||||
只勾选代码片段（`gists`）相关权限。如果界面只提供合并权限，选择能够读写代码片段的最小权限。
|
||||
</Step>
|
||||
<Step>
|
||||
### 保存令牌
|
||||
|
||||
生成后立即复制令牌，并存放在密码管理器中。
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### 上传与恢复
|
||||
|
||||
@@ -38,10 +38,26 @@ A GitHub **fine-grained personal access token** is recommended:
|
||||
[Open the GitHub fine-grained token creation page](https://github.com/settings/personal-access-tokens/new)
|
||||
|
||||
<Steps>
|
||||
<Step>### Open token settings Sign in to GitHub and open **Settings → Developer settings → Personal access tokens → Fine-grained tokens**.</Step>
|
||||
<Step>### Create a token Select **Generate new token**, then set a name and expiration.</Step>
|
||||
<Step>### Grant permission Under **Account permissions**, set **Gists** to **Read and write**. Repository permissions are not required.</Step>
|
||||
<Step>### Save the token Copy the token immediately. GitHub only displays the complete token once.</Step>
|
||||
<Step>
|
||||
### Open token settings
|
||||
|
||||
Sign in to GitHub and open **Settings → Developer settings → Personal access tokens → Fine-grained tokens**.
|
||||
</Step>
|
||||
<Step>
|
||||
### Create a token
|
||||
|
||||
Select **Generate new token**, then set a name and expiration.
|
||||
</Step>
|
||||
<Step>
|
||||
### Grant permission
|
||||
|
||||
Under **Account permissions**, set **Gists** to **Read and write**. Repository permissions are not required.
|
||||
</Step>
|
||||
<Step>
|
||||
### Save the token
|
||||
|
||||
Copy the token immediately. GitHub only displays the complete token once.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
A classic token also works, but grant only the `gist` scope.
|
||||
@@ -49,9 +65,21 @@ A classic token also works, but grant only the `gist` scope.
|
||||
### First Upload
|
||||
|
||||
<Steps>
|
||||
<Step>### Select GitHub Open **Settings → Sync → GitHub / Gitee** and select **GitHub Gist**.</Step>
|
||||
<Step>### Enter the token Paste the access token. Enabling **Store encrypted on this device** is recommended.</Step>
|
||||
<Step>### Create the Gist Leave **Snippet ID** empty and select **Upload**. DBX creates a private Gist and stores the returned ID.</Step>
|
||||
<Step>
|
||||
### Select GitHub
|
||||
|
||||
Open **Settings → Sync → GitHub / Gitee** and select **GitHub Gist**.
|
||||
</Step>
|
||||
<Step>
|
||||
### Enter the token
|
||||
|
||||
Paste the access token. Enabling **Store encrypted on this device** is recommended.
|
||||
</Step>
|
||||
<Step>
|
||||
### Create the Gist
|
||||
|
||||
Leave **Snippet ID** empty and select **Upload**. DBX creates a private Gist and stores the returned ID.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
DBX stores an encrypted `dbx-sync.json` file in the Gist. The snippet encryption password protects the complete snapshot, so the URL does not expose connection details, SQL, or settings. Existing plain-text snippets can still be downloaded once for migration.
|
||||
@@ -74,10 +102,26 @@ Plain-text snippets created by older versions cannot be safely migrated in place
|
||||
[Open the Gitee personal access token page](https://gitee.com/profile/personal_access_tokens)
|
||||
|
||||
<Steps>
|
||||
<Step>### Open token settings Sign in to Gitee and open **Settings → Personal Access Tokens**.</Step>
|
||||
<Step>### Create a token Select **Generate new token** and enter a description.</Step>
|
||||
<Step>### Grant permission Select only the code snippet (`gists`) permission. If permissions are grouped, choose the smallest permission that allows reading and writing snippets.</Step>
|
||||
<Step>### Save the token Copy the generated token immediately and store it in a password manager.</Step>
|
||||
<Step>
|
||||
### Open token settings
|
||||
|
||||
Sign in to Gitee and open **Settings → Personal Access Tokens**.
|
||||
</Step>
|
||||
<Step>
|
||||
### Create a token
|
||||
|
||||
Select **Generate new token** and enter a description.
|
||||
</Step>
|
||||
<Step>
|
||||
### Grant permission
|
||||
|
||||
Select only the code snippet (`gists`) permission. If permissions are grouped, choose the smallest permission that allows reading and writing snippets.
|
||||
</Step>
|
||||
<Step>
|
||||
### Save the token
|
||||
|
||||
Copy the generated token immediately and store it in a password manager.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Upload and Restore
|
||||
|
||||
@@ -10,19 +10,51 @@ description: 导出数据库连接配置（AES-256-GCM 加密），安全地在
|
||||
## 导出
|
||||
|
||||
<Steps>
|
||||
<Step>### 发起导出 点击侧边栏顶部的 **导出** 按钮。</Step>
|
||||
<Step>### 选择连接 勾选一个或多个连接。默认全选。最终只会导出已选连接、相关的侧边栏分组和排序，以及引用的隧道配置（Tunnel Profile）。</Step>
|
||||
<Step>### 选择导出保护 输入密码短语来加密连接密码。仅在可信环境下临时迁移时，也可以选择**不加密导出**并确认风险。明文文件可能包含数据库密码、SSH Tunnel 凭据和其他敏感信息。</Step>
|
||||
<Step>### 保存文件 选择保存位置。导出文件只包含已选连接、相关布局和引用的 Tunnel Profile。推荐使用加密导出。</Step>
|
||||
<Step>
|
||||
### 发起导出
|
||||
|
||||
点击侧边栏顶部的 **导出** 按钮。
|
||||
</Step>
|
||||
<Step>
|
||||
### 选择连接
|
||||
|
||||
勾选一个或多个连接。默认全选。最终只会导出已选连接、相关的侧边栏分组和排序，以及引用的隧道配置（Tunnel Profile）。
|
||||
</Step>
|
||||
<Step>
|
||||
### 选择导出保护
|
||||
|
||||
输入密码短语来加密连接密码。仅在可信环境下临时迁移时，也可以选择**不加密导出**并确认风险。明文文件可能包含数据库密码、SSH Tunnel 凭据和其他敏感信息。
|
||||
</Step>
|
||||
<Step>
|
||||
### 保存文件
|
||||
|
||||
选择保存位置。导出文件只包含已选连接、相关布局和引用的 Tunnel Profile。推荐使用加密导出。
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 导入
|
||||
|
||||
<Steps>
|
||||
<Step>### 发起导入 点击侧边栏顶部的 **导入** 按钮。</Step>
|
||||
<Step>### 选择文件并解密 选择导出的文件。DBX 会自动识别加密和明文配置文件；加密文件会先要求输入密码短语，DBX 会先解密并预览，此时不会写入本地连接。</Step>
|
||||
<Step>### 选择连接 勾选文件中要导入的连接。默认全选。</Step>
|
||||
<Step>### 完成 只有已选连接会被导入，密码自动恢复。按 名称 + 主机 + 端口 自动去重。已选连接的侧边栏分组和排序仍可在导入后选择应用。</Step>
|
||||
<Step>
|
||||
### 发起导入
|
||||
|
||||
点击侧边栏顶部的 **导入** 按钮。
|
||||
</Step>
|
||||
<Step>
|
||||
### 选择文件并解密
|
||||
|
||||
选择导出的文件。DBX 会自动识别加密和明文配置文件；加密文件会先要求输入密码短语，DBX 会先解密并预览，此时不会写入本地连接。
|
||||
</Step>
|
||||
<Step>
|
||||
### 选择连接
|
||||
|
||||
勾选文件中要导入的连接。默认全选。
|
||||
</Step>
|
||||
<Step>
|
||||
### 完成
|
||||
|
||||
只有已选连接会被导入，密码自动恢复。按 名称 + 主机 + 端口 自动去重。已选连接的侧边栏分组和排序仍可在导入后选择应用。
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## 安全性
|
||||
|
||||
@@ -10,22 +10,51 @@ description: Export database connections with AES-256-GCM encrypted passwords. M
|
||||
## Export
|
||||
|
||||
<Steps>
|
||||
<Step>### Start Export Click the **Export** button in the sidebar header.</Step>
|
||||
<Step>### Select Connections Choose one or more connections. All connections are selected by default. Only the selected connections, their sidebar groups and ordering, and referenced tunnel profiles are exported.</Step>
|
||||
<Step>
|
||||
### Choose Export Protection Enter a passphrase to encrypt your passwords. For a one-time migration in a trusted environment, you may instead choose **Export without encryption** and confirm the warning. The plaintext file may contain database passwords, SSH Tunnel credentials, and other
|
||||
sensitive information.
|
||||
<Step>
|
||||
### Start Export
|
||||
|
||||
Click the **Export** button in the sidebar header.
|
||||
</Step>
|
||||
<Step>
|
||||
### Select Connections
|
||||
|
||||
Choose one or more connections. All connections are selected by default. Only the selected connections, their sidebar groups and ordering, and referenced tunnel profiles are exported.
|
||||
</Step>
|
||||
<Step>
|
||||
### Choose Export Protection
|
||||
|
||||
Enter a passphrase to encrypt your passwords. For a one-time migration in a trusted environment, you may instead choose **Export without encryption** and confirm the warning. The plaintext file may contain database passwords, SSH Tunnel credentials, and other sensitive information.
|
||||
</Step>
|
||||
<Step>
|
||||
### Save File
|
||||
|
||||
Choose a save location. The exported file contains only the selected connections, their related layout, and referenced tunnel profiles. Encrypted export is recommended.
|
||||
</Step>
|
||||
<Step>### Save File Choose a save location. The exported file contains only the selected connections, their related layout, and referenced tunnel profiles. Encrypted export is recommended.</Step>
|
||||
</Steps>
|
||||
|
||||
## Import
|
||||
|
||||
<Steps>
|
||||
<Step>### Start Import Click the **Import** button in the sidebar header.</Step>
|
||||
<Step>### Select File and Decrypt Select the exported file. DBX automatically detects encrypted and plain configuration files. Encrypted files ask for the passphrase first so DBX can decrypt and preview them without writing anything yet.</Step>
|
||||
<Step>### Select Connections Choose which connections from the file to import. All connections are selected by default.</Step>
|
||||
<Step>### Done Only the selected connections are imported, with passwords restored. Deduplicated by name + host + port. Sidebar groups and ordering for the selected connections can still be applied after import.</Step>
|
||||
<Step>
|
||||
### Start Import
|
||||
|
||||
Click the **Import** button in the sidebar header.
|
||||
</Step>
|
||||
<Step>
|
||||
### Select File and Decrypt
|
||||
|
||||
Select the exported file. DBX automatically detects encrypted and plain configuration files. Encrypted files ask for the passphrase first so DBX can decrypt and preview them without writing anything yet.
|
||||
</Step>
|
||||
<Step>
|
||||
### Select Connections
|
||||
|
||||
Choose which connections from the file to import. All connections are selected by default.
|
||||
</Step>
|
||||
<Step>
|
||||
### Done
|
||||
|
||||
Only the selected connections are imported, with passwords restored. Deduplicated by name + host + port. Sidebar groups and ordering for the selected connections can still be applied after import.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Security
|
||||
|
||||
Reference in New Issue
Block a user