Files
dbx/docs/content/docs/getting-started.mdx
T
t8y2 51b8b9344f docs: update static docs for v0.5.0 new features
Add documentation for cell detail panel, ORDER BY filter, auto-fit
columns, Copy as INSERT, Redis browser overhaul, create/drop database
and schema, CROSS APPLY/OUTER APPLY completion, OceanBase Oracle mode
detection, and default database setting.
2026-05-09 13:19:39 +08:00

137 lines
3.1 KiB
Plaintext

---
title: Getting Started
description: Install DBX and create your first database connection.
---
## Install
<Tabs groupId="platform" items={['macOS', 'Windows', 'Linux', 'Docker']}>
<Tab value="macOS">
**Homebrew (recommended):**
```bash
brew install --cask t8y2/tap/dbx
```
Update:
```bash
brew upgrade --cask t8y2/tap/dbx
```
You can also download the `.dmg` installer from the [Releases](https://github.com/t8y2/dbx/releases) page.
</Tab>
<Tab value="Windows">
**Scoop (recommended):**
```bash
scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx
```
Update:
```bash
scoop update dbx
```
You can also download the `.msi` installer from the [Releases](https://github.com/t8y2/dbx/releases) page.
</Tab>
<Tab value="Linux">
Download the appropriate package (`.deb` / `.AppImage`) from the [Releases](https://github.com/t8y2/dbx/releases) page.
</Tab>
<Tab value="Docker">
Run DBX as a self-hosted web application using Docker:
```bash
docker run -d --name dbx -p 4224:4224 -v dbx-data:/app/data t8y2/dbx
```
Then open `http://localhost:4224` in your browser.
**Docker Compose:**
```yaml
services:
dbx:
image: t8y2/dbx
ports:
- "4224:4224"
volumes:
- dbx-data:/app/data
restart: unless-stopped
volumes:
dbx-data:
```
</Tab>
</Tabs>
## Create Your First Connection
<Steps>
<Step>
### New Connection
Click the **New Connection** button in the toolbar.
</Step>
<Step>
### Select Database Type
Choose the database engine you want to connect to (MySQL, PostgreSQL, SQLite, etc.).
</Step>
<Step>
### Enter Connection Details
Fill in host, port, username, and password. Optionally set a **default database** to connect to a specific database automatically. For databases behind a firewall, enable the [SSH Tunnel](/en/docs/ssh-tunnel).
</Step>
<Step>
### Test and Save
Click **Test** to verify the connection, then click **Save & Connect**.
</Step>
</Steps>
<Callout type="info">
Connection passwords are stored in your system keyring (macOS Keychain / Windows Credential Manager / Linux Secret Service), never as plain text in config files.
</Callout>
## Development Setup
To run DBX from source:
### Prerequisites
- [Node.js](https://nodejs.org/) >= 18
- [pnpm](https://pnpm.io/)
- [Rust](https://www.rust-lang.org/tools/install) >= 1.77
### System Dependencies
<Tabs groupId="dev-platform" items={['macOS', 'Linux', 'Windows']}>
<Tab value="macOS">
```bash
brew install unixodbc
```
</Tab>
<Tab value="Linux">
```bash
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev unixodbc-dev
```
</Tab>
<Tab value="Windows">
No additional dependencies required (ODBC is built into Windows).
</Tab>
</Tabs>
### Run
```bash
git clone https://github.com/t8y2/dbx.git
cd dbx
pnpm install
pnpm dev:tauri
```
### Build
```bash
pnpm tauri build
```
The installer will be in `src-tauri/target/release/bundle/`.