CELERITY面板

Download required files

curl -O https://raw.githubusercontent.com/ClickDevTech/hysteria-panel/main/docker-compose.hub.yml curl -O https://raw.githubusercontent.com/ClickDevTech/hysteria-panel/main/docker.env.example

Create Greenlock SSL config (required for HTTPS)

mkdir -p greenlock.d curl -o greenlock.d/config.json https://raw.githubusercontent.com/ClickDevTech/hysteria-panel/main/greenlock.d/config.json

cp docker.env.example .env nano .env # Set your domain, email, and secrets docker compose -f docker-compose.hub.yml up -d

**Alternative: Build from source** (for development or customization)

**3. Open** `https://your-domain/panel`
> Planning to manage the panel from AI assistants? See [MCP Setup Guide](docs/mcp-user-guide.md).

**Local development (HTTP only, no domain/SSL):**

Want to try the panel on your laptop without a public domain or certificate? Use the local compose file — it sets `USE_CADDY=true` (plain HTTP, no Greenlock/ACME) and publishes port `3000` directly, with dev defaults so it boots without a `.env`:

Development Mode (build from current branch)

1. In Dokploy, create a project from this repository/branch. 2. Set compose path to docker-compose.dokploy.yml. 3. Add env vars from docker.env.example and set at least: - MONGO_PASSWORD - PANEL_DOMAIN - ACME_EMAIL - ENCRYPTION_KEY - SESSION_SECRET - DOKPLOY_PANEL_HOST (domain used in Traefik Host(...) rule) - DOKPLOY_TRAEFIK_SERVICE_PORT (Traefik target/backend port, default 3000) 4. Deploy: Dokploy will run build: . and start the stack.

This mode is best when you test branch changes before publishing a release image.

Release Mode (Docker Hub image)

If you want stable deploys from Docker Hub tags (without building), replace backend image source in Dokploy compose with:

backend:
  image: clickdevtech/hysteria-panel:latest
  # or pin a release tag, e.g. clickdevtech/hysteria-panel:v1.2.3
  restart: always
  depends_on:
    mongo:
      condition: service_healthy
    redis:
      condition: service_healthy
  expose:
    - "${DOKPLOY_TRAEFIK_SERVICE_PORT:-3000}"
  labels:
    - "traefik.enable=true"
    - "traefik.http.routers.celerity.rule=Host(`${DOKPLOY_PANEL_HOST}`)"
    - "traefik.http.routers.celerity.entrypoints=websecure"
    - "traefik.http.routers.celerity.tls=true"
    - "traefik.http.services.celerity.loadbalancer.server.port=${DOKPLOY_TRAEFIK_SERVICE_PORT:-3000}"
  env_file:
    - .env

Use latest for fast updates, or pin an explicit tag for predictable production rollouts.

---

🚀 Xray Node Setup

Automatic Setup (Recommended)

1. Add node in panel: - Type: Xray - IP, SSH credentials - Security: Reality (recommended) - Transport: TCP (recommended for Reality)

1. Click "⚙️ Auto Setup"

3. Panel will automatically: - Install Xray-core - Generate Reality keys (x25519) - Upload config - Install CC Agent for user management - Open firewall ports - Start services

🔧 Hysteria Node Setup

Automatic Setup (Recommended)

1. Add node in panel (IP, SSH credentials) 2. Click "⚙️ Auto Setup" 3. Panel will automatically: - Install Hysteria 2 - Configure ACME or self-signed certificates - Set up port hopping - Open firewall ports - Start service

Single VPS Setup (Panel + Node)

You can run panel and node on the same VPS (panel TCP, node UDP on 443).

Option 1: Use panel domain (recommended) - Set node domain same as panel domain - Panel certificates will be copied automatically

Option 2: No domain (self-signed) - Leave domain field empty - Self-signed certificate will be generated

---

🐳 Docker Compose

version: '3.8'

services:
  mongo:
    image: mongo:7
    restart: always
    volumes:
      - mongo_data:/data/db
    environment:
      MONGO_INITDB_ROOT_USERNAME: ${MONGO_USER:-hysteria}
      MONGO_INITDB_ROOT_PASSWORD: ${MONGO_PASSWORD}

  backend:
    image: clickdevtech/hysteria-panel:latest
    restart: always
    depends_on:
      - mongo
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./logs:/app/logs
      - ./greenlock.d:/app/greenlock.d
      - ./backups:/app/backups
    env_file:
      - .env

volumes:
  mongo_data:

---

⚡ Quick Start

Updating an existing installation? See Safe Production Updates.

1. Install Docker (if not installed):

curl -fsSL https://get.docker.com | sh

2. Deploy panel (Docker Hub - recommended): ```bash mkdir hysteria-panel && cd hysteria-panel

Rule Examples

reject(suffix:doubleclick.net)     # Block ads
reject(suffix:googlesyndication.com)
reject(geoip:cn)                   # Block Chinese IPs
reject(geoip:private)              # Block private IPs
direct(all)                        # Allow everything else

Reality Settings

Understanding Node Configuration

#### Ports - Main port (443) — Port Hysteria listens on - Port hopping range (20000-50000) — UDP ports for hopping - Stats port (9999) — Internal port for stats collection

Domain vs SNI

Scenarios: 1. Simple setup: Set domain, leave SNI empty 2. Domain fronting: Set domain for certs, SNI as popular domain 3. No domain: Leave empty — self-signed certificate will be used

Option 1 — header

X-API-Key: ck_your_key_here

Option 2 — Bearer token

Authorization: Bearer ck_your_key_here ```

Scopes

Rate Limiting

Each key has a configurable rate limit (default: 60 req/min). Exceeded requests return 429 with X-RateLimit-Limit / X-RateLimit-Remaining headers.

---

📝 Environment Variables

---

📖 API Reference

API Key Authentication

All /api/* endpoints (except /api/auth and /api/files) require authentication.

Create a key: Settings → Security → API Keys → Create Key

Usage: ```http