Skip to content

docs: add Zeabur one-click deployment guide #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
faithleysath wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −0
Open

docs: add Zeabur one-click deployment guide #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/guide/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ The hub can be deployed on:

- **Local desktop** (default) - Run on your development machine
- **Remote host** - Deploy the hub on a VPS, cloud host, or any machine with network access
- **Zeabur** - One-click deployment with automatic SSL and domain

### Default: Public Relay (recommended)

Expand All @@ -137,6 +138,33 @@ The terminal displays a URL and QR code. Scan to access from anywhere.

> **Tip:** The relay uses UDP by default. If you experience connectivity issues, set `HAPI_RELAY_FORCE_TCP=true` to force TCP mode.

### Zeabur (One-Click Deploy)

[Zeabur](https://zeabur.com) provides one-click deployment with automatic SSL certificates and a free domain.

**Deploy steps:**

1. Click [One-Click Deploy](https://zeabur.com/templates/7L445I) to create the service
2. Configure the required environment variables:
- `PUBLIC_DOMAIN` - Your desired domain (a free `zeabur.app` domain is provided)
Copy link

@github-actions github-actions bot Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[MAJOR] Docs correctness: wrong env var name

Why this is a problem: PUBLIC_DOMAIN is not read by the hub; the documented env var for public URL is HAPI_PUBLIC_URL, so following these steps leaves the hub unaware of its public URL.

Suggested fix:

-   - `PUBLIC_DOMAIN` - Your desired domain (a free `zeabur.app` domain is provided)
+   - `HAPI_PUBLIC_URL` - Public URL for external access (use your `zeabur.app` domain)

- `TELEGRAM_BOT_TOKEN` - Optional, for Telegram bot integration
3. Zeabur automatically handles SSL certificates and service startup
4. Copy the generated API key from the deployment output

**Connect to your Zeabur hub:**

```bash
export HAPI_API_URL="https://your-domain.zeabur.app"
export CLI_API_TOKEN="your-token"
hapi
```

**Telegram integration (optional):**

If you configured a Telegram bot token, message `/start` to your bot to control sessions from Telegram.

---

### Local Only

```bash
Expand Down
Loading