DBX Configuration Cloud Sync
DBX can package connections, application settings, and saved SQL into a snapshot, upload it to WebDAV or a private code snippet, and restore it on another device.
Choose a provider under Settings → Sync:
- WebDAV: Best when you already use a NAS, Nextcloud, or another WebDAV service. Supports scheduled uploads.
- GitHub / Gitee snippets: Stores the snapshot in a private Gist or code snippet without requiring your own server. Uploads and downloads are currently manual.
What Is Synchronized
| Item | Default behavior |
|---|---|
| Database connections and non-secret options | Synchronized |
| Sidebar layout and pinned nodes | Synchronized |
| Saved SQL library | Synchronized |
| Desktop and editor settings | Synchronized |
| Database, SSH, proxy, HTTP tunnel, connection string, and AI API secrets | Excluded by default; can be encrypted and synchronized |
| JDBC drivers, plugins, and local files | Not synchronized |
Downloading replaces local connection metadata and saved SQL with the remote snapshot. Verify the snippet ID or WebDAV path before restoring.
GitHub Gist
Create an Access Token
A GitHub fine-grained personal access token is recommended:
Open the GitHub fine-grained token creation page
A classic token also works, but grant only the gist scope.
First Upload
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.
Plain-text snippets created by older versions cannot be safely migrated in place: updating the same Gist does not remove its revision history. Use Migrate legacy snippet instead. DBX encrypts the existing remote snapshot into a new snippet first, stores the new ID locally, and then rereads the old snippet before deleting it. If another device changed the old content, DBX stops automatic cleanup and tells you which old snippet must be deleted manually. If the old snapshot contains encrypted credentials, enter its original credentials password so DBX can verify them before cleanup. Rotate any credentials the old snippet may have exposed.
Restore on Another Device
- Open the private Gist and copy its ID from the URL. The URL normally looks like
https://gist.github.com/<actual-username>/<gist-id>, where the final segment is the ID. You can also openhttps://gist.github.com/<gist-id>and let GitHub redirect to the URL containing the actual username. - Enter the same GitHub token and Gist ID on the new device.
- Select Test to verify access.
- Select Download and confirm the restore.
Gitee Snippets
Create a Personal Access Token
Open the Gitee personal access token page
gists) permission. If permissions are grouped, choose the smallest permission that allows reading and writing snippets.Upload and Restore
- Select Gitee Snippet under Settings → Sync → GitHub / Gitee.
- Enter the personal access token. Leave the snippet ID empty on the first upload; DBX creates a private snippet and stores its ID.
- To restore elsewhere, enter the same snippet ID and select Download.
Gitee snippets also use a dbx-sync.json file.
Sync Password and Secrets
GitHub Gist and Gitee snippets always encrypt the entire snapshot with a snippet encryption password. The password is never uploaded or saved and cannot be recovered. This password is independent from the password that encrypts optional synced credentials.
Snapshots exclude credentials by default. To restore passwords on another device:
- Enable Include encrypted credentials when uploading.
- Enter a separate sync password for credentials.
- Upload the snapshot.
- On another device, enable Restore encrypted credentials when downloading and enter the same credentials password. Leave it off to keep local passwords unchanged.
DBX derives the encryption key with Argon2id and uses AES-256-GCM encryption. Provider access tokens are encrypted with a device-local key and are never written to dbx-sync.json.
Neither password can be recovered. An encrypted GitHub/Gitee snippet cannot be restored without its snippet encryption password. For WebDAV, a snapshot without encrypted secrets can still be restored without a passphrase.
WebDAV
Enter the WebDAV endpoint, username, application password, and remote snapshot path. The default path is DBX/sync/snapshot.json.
WebDAV supports scheduled uploads while DBX is running. Downloads always require confirmation to prevent accidental replacement of local data.
Troubleshooting
HTTP 401 or 403
The token is invalid, expired, or missing snippet read/write permission. Create a new least-privilege token and test again.
HTTP 404
The snippet ID is incorrect, or the current token cannot access the private snippet.
Where is the ID after the first upload?
DBX stores it automatically. You can also find it in the URL of the GitHub Gist or Gitee snippet page.
Can multiple devices synchronize automatically?
Snippet synchronization currently uses manual upload and download and does not merge concurrent changes. Download the latest snapshot before uploading to avoid replacing changes from another device.