Files
dbx/docs/content/docs/getting-started.mdx
T
t8y2 aab6d7c3a4 docs: add system dependencies and update GaussDB driver info
- Add platform-specific system dependencies (unixODBC, Tauri libs) to
  README and getting-started docs
- Update GaussDB driver from odbc-api to rust-gaussdb in database docs
- Remove obsolete GaussDB ODBC setup instructions
- Fix Docker image and port in getting-started docs
2026-05-07 13:18:02 +08:00

111 lines
1.8 KiB
Plaintext

---
title: Getting Started
description: Install DBX and create your first database connection.
---
# Getting Started
## Install
Download the latest release from the [Releases](https://github.com/t8y2/dbx/releases) page.
### Homebrew (macOS)
```bash
brew install --cask t8y2/tap/dbx
```
Update:
```bash
brew upgrade --cask t8y2/tap/dbx
```
### Scoop (Windows)
```bash
scoop bucket add dbx https://github.com/t8y2/scoop-bucket
scoop install dbx
```
Update:
```bash
scoop update dbx
```
### Docker (Self-Hosted)
You can 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.
For Docker Compose:
```yaml
services:
dbx:
image: t8y2/dbx
ports:
- "4224:4224"
volumes:
- dbx-data:/app/data
restart: unless-stopped
volumes:
dbx-data:
```
## Create Your First Connection
1. Click **New Connection** in the toolbar
2. Select your database type (MySQL, PostgreSQL, etc.)
3. Fill in host, port, username, password
4. Click **Test** to verify the connection
5. Click **Save & Connect**
## Development Setup
### Prerequisites
- [Node.js](https://nodejs.org/) >= 18
- [pnpm](https://pnpm.io/)
- [Rust](https://www.rust-lang.org/tools/install) >= 1.77
#### System Dependencies
**macOS:**
```bash
brew install unixodbc
```
**Linux (Ubuntu/Debian):**
```bash
sudo apt-get install -y libwebkit2gtk-4.1-dev libgtk-3-dev libappindicator3-dev librsvg2-dev patchelf libssl-dev unixodbc-dev
```
**Windows:**
No additional dependencies required (ODBC is built into Windows).
### 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/`.