Local Setup
Dependencies
- Go 1.22+
- Node.js 20+
- pnpm
- Docker (for PostgreSQL)
1. Start PostgreSQL
Connectivity check:
2. Start the API service
The default listen address is 127.0.0.1:19001.
Linux/macOS
Windows
To override the listen address:
3. Start the Worker service
4. Start the Web app
docker compose up -d already includes the Gateway on port 19000. Point the frontend proxy to the Gateway:
Linux/macOS
Windows
5. Start the Console app
Linux/macOS
Windows
Integration tests
Environment variables at a glance
| Variable | Description | Default |
|---|---|---|
ARKLOOP_DATABASE_URL | PostgreSQL connection string | — |
ARKLOOP_API_GO_ADDR | API listen address | 127.0.0.1:19001 |
ARKLOOP_LOAD_DOTENV | Automatically load from a .env file | 0 |
ARKLOOP_DOTENV_FILE | Path to the .env file | .env |
ARKLOOP_TOOL_ALLOWLIST | Deprecated compatibility flag; logged but does not gate runtime tools | — |
ARKLOOP_JWT_SECRET | JWT signing secret | — |
See .env.example for the complete environment variable reference.