DBXDBX

Getting Started

Install DBX, create your first connection, and understand the desktop, Docker, and source workflows.

This guide gets you through three things:

  1. Install DBX or start the Docker version
  2. Create and test your first database connection
  3. Run DBX from source when you want to contribute or debug locally

Choose An Install Method

Install with Homebrew:

brew install --cask t8y2/tap/dbx

Update later with:

brew upgrade --cask t8y2/tap/dbx

You can also download a .dmg installer from GitHub Releases.

Install with Scoop:

scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx

Update later with:

scoop update dbx

You can also download a .msi installer from GitHub Releases.

Download a package from GitHub Releases:

FormatUse Case
.debDebian, Ubuntu, and compatible distributions
.AppImagePortable Linux desktop usage

For .AppImage, make the file executable before first run:

chmod +x DBX*.AppImage

Docker is for self-hosting DBX on a server and opening it from a browser:

docker run -d \
  --name dbx \
  -p 4224:4224 \
  -v dbx-data:/app/data \
  t8y2/dbx

Then open http://localhost:4224.

Docker Compose:

services:
  dbx:
    image: t8y2/dbx
    ports:
      - "4224:4224"
    volumes:
      - dbx-data:/app/data
    restart: unless-stopped

volumes:
  dbx-data:

Desktop Or Docker

ModeBest ForBackend PathStorage
DesktopDaily local work, local files, native windows, DBX UI opened from MCPTauri commands calling the Rust coreLocal app data directory
Docker / WebSelf-hosted access from a server or browserHTTP routes calling the same Rust coreDocker volume or server data directory

The core database features are shared, but desktop-only integrations such as opening DBX windows from MCP require the desktop app to be running.

Create Your First Connection

Open New Connection

Click New Connection from the sidebar or toolbar.

Pick A Database Type

Choose a built-in profile such as MySQL, PostgreSQL, SQLite, Redis, MongoDB, DuckDB, ClickHouse, SQL Server, Oracle, or one of the compatibility and Agent/JDBC profiles listed in Database Support.

Fill Connection Details

For network databases, enter host, port, username, password, and default database when needed. For SQLite, DuckDB, and Access, select a local database file instead of host and port.

Paste A URL When Available

DBX can parse common connection URLs for engines such as MySQL, PostgreSQL, Redis, MongoDB, ClickHouse, SQL Server, Oracle, Elasticsearch, DM, GaussDB, openGauss, TDengine, and Access. Review the parsed fields before saving.

Add Network Options

Enable SSH Tunnel for databases behind private networks or bastion hosts. Use the proxy tab when your environment requires SOCKS5 or HTTP proxy access.

Test And Save

Click Test to verify credentials, network access, and permissions. After the test passes, save the connection and open it from the sidebar.

Connection passwords, SSH passwords, SSH key passphrases, and connection strings are stored separately from the regular connection JSON in DBX's local storage. Use Config Export/Import when you need to migrate encrypted connection settings.

Reduce Production Mistakes

  • Give production connections a distinct name, for example prod-orders.
  • Use connection colors so production, staging, and local databases are visually different.
  • Use visible database filtering when a server contains many databases but you only need a few.
  • Review generated SQL before applying edits, imports, transfers, SQL files, or schema sync operations.

What To Try Next

Write SQL

Use completion, formatting, selected execution, cancellation, and history.

Browse Data

Inspect results, edit rows when safe, preview SQL, and export data.

Explore Schema

Browse databases, schemas, tables, columns, Redis keys, and MongoDB collections.

Common Connection Problems

SymptomCheck
TimeoutHost, port, firewall, security group, VPN, Docker host reachability, or private network access
Authentication failedUsername, password, auth mode, SSL requirement, remote login permission
Connected but no tablesDefault database, schema, permissions, metadata read access, visible database filter
File database cannot openFile path, file permissions, mounted Docker volume, or unsupported file extension
Private database unreachableConfigure SSH tunnel, proxy, VPN, or run Docker on a machine that can reach the database

Run From Source

Use source mode when contributing or debugging DBX locally.

Requirements

System Dependencies

brew install unixodbc
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev unixodbc-dev

Windows usually needs no extra system dependency for local DBX development.

Start Development

git clone https://github.com/t8y2/dbx.git
cd dbx
pnpm install
pnpm dev:tauri

For the web version:

pnpm dev:web
pnpm dev:backend

Build Desktop Packages

pnpm tauri build

Desktop installers are written to src-tauri/target/release/bundle/.

What is DBX?

DBX is an open-source database workspace for connections, SQL editing, data grids, schema tools, AI assistance, and self-hosted access.

Database Support

Understand which databases DBX can connect to and which advanced features are available per engine.

On this page

Choose An Install MethodDesktop Or DockerCreate Your First ConnectionOpen New ConnectionPick A Database TypeFill Connection DetailsPaste A URL When AvailableAdd Network OptionsTest And SaveReduce Production MistakesWhat To Try NextCommon Connection ProblemsRun From SourceRequirementsSystem DependenciesStart DevelopmentBuild Desktop Packages