Files
dbx/docs/content/docs/getting-started.mdx
T
t8y2 6a5a380fdd docs: migrate from VitePress to Fumadocs (Next.js)
- Replace VitePress with Fumadocs + Next.js for documentation site
- Configure i18n (English + 简体中文) with language switcher
- Migrate all 17 guide documents to MDX format with updated content
- Add ocean theme, GitHub/Discord/QQ social links
- Update GitHub Actions workflow for Next.js static export
- Update .gitignore for .next, out, .source directories
2026-05-06 10:17:17 +08:00

93 lines
1.5 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 3000:3000 ghcr.io/t8y2/dbx:latest
```
Then open `http://localhost:3000` in your browser.
For Docker Compose:
```yaml
services:
dbx:
image: ghcr.io/t8y2/dbx:latest
ports:
- "3000:3000"
volumes:
- dbx-data:/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
### 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/`.