wehub-resource-sync
92 lines
3.2 KiB
Markdown
92 lines
3.2 KiB
Markdown
# Docker deployment
|
|
|
|
This image runs the core server package with PM2 and serves the built UI package
|
|
through Nginx. Nginx is the only published entrypoint: it serves the UI, proxies
|
|
management API calls to the internal core server, and proxies gateway API calls
|
|
to the internal gateway listener.
|
|
|
|
## Build and run
|
|
|
|
```sh
|
|
docker compose up --build
|
|
```
|
|
|
|
Then open:
|
|
|
|
- Web UI: <http://localhost:3458>
|
|
- Gateway endpoint: <http://localhost:3458>
|
|
|
|
`docker-compose.yml` publishes only Nginx (`3458:8080`). Behind Nginx, the image
|
|
runs separate container-private listeners for management RPC, API gateway
|
|
routing, and the core gateway runtime. They are implementation details and are
|
|
not published or configured by the default Compose file.
|
|
|
|
To use a different host port, change the Compose port mapping and keep the
|
|
public router endpoint in sync:
|
|
|
|
```yaml
|
|
services:
|
|
ccr:
|
|
ports:
|
|
- "8088:8080"
|
|
environment:
|
|
CCR_PUBLIC_BASE_URL: http://127.0.0.1:8088
|
|
```
|
|
|
|
The container stores config and SQLite databases under `/data`, backed by the
|
|
`ccr-data` volume in `docker-compose.yml`.
|
|
|
|
On a fresh data volume, the Web UI starts immediately. The gateway endpoint is
|
|
available through the same Nginx entrypoint, but the gateway only starts after at
|
|
least one provider and model are configured.
|
|
|
|
## Image scripts
|
|
|
|
```sh
|
|
npm run docker:build
|
|
npm run docker:run
|
|
```
|
|
|
|
## Smoke test
|
|
|
|
```sh
|
|
npm run test:docker
|
|
```
|
|
|
|
The smoke test builds the image, starts an isolated temporary container with a
|
|
special-character `CCR_WEB_AUTH_TOKEN`, verifies that only the Nginx port is
|
|
published, checks UI and RPC authentication, confirms legacy Docker config is
|
|
migrated to the public Nginx router endpoint, and removes its temporary
|
|
container and volume. Set `CCR_DOCKER_TEST_SKIP_BUILD=1` to reuse an already
|
|
built image.
|
|
|
|
The Dockerfile uses `node:22-bookworm` for build and native SQLite dependency
|
|
installation, then copies the production dependencies into a smaller
|
|
`node:22-bookworm-slim` runtime image. To use different base images:
|
|
|
|
```sh
|
|
docker build \
|
|
--build-arg NODE_IMAGE=node:22-bookworm \
|
|
--build-arg RUNTIME_NODE_IMAGE=node:22-bookworm-slim \
|
|
-t claude-code-router:local .
|
|
```
|
|
|
|
## Environment
|
|
|
|
Most deployments only need the published Nginx port mapping, `CCR_WEB_AUTH_TOKEN`,
|
|
and optionally `CCR_PUBLIC_BASE_URL` when the host-facing URL is not
|
|
`http://127.0.0.1:3458`.
|
|
|
|
| Variable | Default | Description |
|
|
| --- | --- | --- |
|
|
| `CCR_WEB_AUTH_TOKEN` | generated | Shared management UI token used by Nginx redirects and the core server. |
|
|
| `CCR_PUBLIC_BASE_URL` | `http://127.0.0.1:3458` | Full public router endpoint override. Set this when changing the host-facing Compose port. |
|
|
| `CCR_DATA_DIR` | `/data` | Container data root. |
|
|
| `CCR_NO_GATEWAY` | `0` | Set to `1` to run only the Web UI management service. |
|
|
| `CCR_DOCKER_INIT_CONFIG` | `1` | Set to `0` to disable first-run `config.json` bootstrap. |
|
|
| `CCR_DOCKER_SYNC_PUBLIC_ENDPOINT` | `1` | Sync existing Docker config to the Nginx public router endpoint on startup. |
|
|
|
|
The first-run bootstrap writes a minimal legacy `config.json` only when neither
|
|
`config.json` nor `config.sqlite` exists in the mounted data directory. Once the
|
|
UI saves settings into SQLite, existing persisted configuration takes priority.
|