Hook AI网关

Deployment

Docker Compose (Recommended: Prebuilt GHCR Image)

Stable release tags publish the multi-arch image ghcr.io/zzispp/hook. latest points to the latest stable release, while edge and nightly point to the latest main build. This deployment starts PostgreSQL, Redis, and the prebuilt Hook image, runs migration up, then serves the frontend and API from http://127.0.0.1:5555.

git clone https://github.com/zzispp/Hook.git
cd Hook
HOOK_COMPOSE_FILES=docker-compose.prebuilt.yml ./deploy.sh

./deploy.sh creates .env on first run, asks for the administrator username, email, and password, then starts Docker Compose. PostgreSQL password, JWT secret, and provider key encryption secret are generated automatically. PostgreSQL and Redis runtime data is stored in the hook-postgres and hook-redis Docker named volumes.

To pin a published image tag instead of latest, set HOOK_IMAGE_TAG:

HOOK_IMAGE_TAG=v1.0.1 HOOK_COMPOSE_FILES=docker-compose.prebuilt.yml ./deploy.sh

Useful commands:

docker compose --env-file .env -f docker-compose.prebuilt.yml logs -f hook
docker compose --env-file .env -f docker-compose.prebuilt.yml ps
docker compose --env-file .env -f docker-compose.prebuilt.yml down

docker compose down stops containers without deleting named volumes. Do not run docker compose down -v unless the deployment data should be deleted.

Docker Compose Source Build

Use source-build deployment when you want to build the image locally from this checkout. It compiles the embedded frontend and backend inside Docker, starts PostgreSQL and Redis, runs migration up, then serves the frontend and API from http://127.0.0.1:5555.

git clone https://github.com/zzispp/Hook.git
cd Hook
./deploy.sh

For source-build deployments, update with:

./update.sh

update.sh runs git pull --ff-only, pulls build-independent service images, rebuilds the Hook image from the current source tree, and recreates the containers. It does not delete Docker named volumes.

Source Build Without Docker

Source build deployment uses the same embedded frontend path without Docker. PostgreSQL and Redis must be running, and config.yaml must point to them before the migration command runs.

```bash pnpm install cp config/config.yaml config.yaml scripts/generate-password-hash.sh "your-password"

Build, Config, and Database

pnpm build:frontend
pnpm build:backend
NEXT_PUBLIC_SERVER_URL=http://127.0.0.1:5555 pnpm build:backend:embedded
NEXT_PUBLIC_SERVER_URL=http://127.0.0.1:5555 pnpm start:embedded

Important config keys include server.*, database.*, redis.*, jwt.secret, security.provider_key_secret, admin.*, auth.*, tracing.log_level, NEXT_PUBLIC_SERVER_URL, and HOOK_BACKEND_URL.

Migration commands:

cargo run -p hook_backend -- migration up       # Apply baseline without clearing complete existing tables
cargo run -p hook_backend -- migration status   # Show baseline table status
cargo run -p hook_backend -- migration down     # Drop baseline tables and marker
cargo run -p hook_backend -- migration fresh    # Drop and recreate baseline
cargo run -p hook_backend -- migration refresh  # Drop and recreate baseline
cargo run -p hook_backend -- migration reset    # Drop baseline tables and marker

Update config.yaml with the printed password hash, database, Redis, and secret values.

cargo run -p hook_backend -- migration up pnpm build:frontend:embedded cargo run -p hook_backend ```

API Entrypoints

• GET /health: health check.
• /api/*: console, admin, auth, wallet, billing, provider, model, and monitoring APIs.
• /v1/*: OpenAI, Claude, and Jina compatible proxy.
• /v1beta/*: Gemini compatible proxy.

Common proxy routes include /v1/models, /v1/chat/completions, /v1/responses, /v1/messages, /v1/images/generations, /v1/embeddings, /v1/rerank, /v1/realtime, /v1beta/models/{model}:generateContent, and /v1beta/models/{model}/embedContent.

GitHub Release Binary Packages

GitHub Releases publish platform packages for Linux and macOS:

• hook-vX.Y.Z-linux-amd64.tar.gz
• hook-vX.Y.Z-linux-arm64.tar.gz
• hook-vX.Y.Z-macos-amd64.tar.gz
• hook-vX.Y.Z-macos-arm64.tar.gz
• install.sh
• SHA256SUMS

These packages contain hook_backend, generate_password_hash, a binary deployment config template, and the license. They are useful when PostgreSQL and Redis are already managed outside Hook. They do not start PostgreSQL or Redis.

curl -fsSL https://github.com/zzispp/Hook/releases/latest/download/install.sh | sudo bash

To install a specific version:

curl -fsSL https://github.com/zzispp/Hook/releases/download/v0.1.0/install.sh | sudo bash -s -- --version v0.1.0

The installer downloads the current platform package, verifies it against SHA256SUMS, installs it under /opt/hook/releases/<version>, updates /opt/hook/current, writes /etc/hook/config.example.yaml, and creates /etc/hook/config.yaml when it does not already exist. Edit /etc/hook/config.yaml, then run:

/opt/hook/current/bin/generate_password_hash "your-password"
/opt/hook/current/bin/hook_backend --config /etc/hook/config.yaml migration up
/opt/hook/current/bin/hook_backend --config /etc/hook/config.yaml