Skip to main content

Quickstart

Get UAPK Gateway running in under 5 minutes.

Prerequisites​

  • Docker and Docker Compose
  • Git

Installation​

# Clone the repository
git clone https://github.com/example/uapk-gateway.git
cd uapk-gateway

# Copy example environment
cp .env.example .env

# Start services
make dev

Verify Installation​

Check that services are running:

# Health check
curl http://localhost:8000/healthz
# Expected: {"status":"ok"}

# Readiness check
curl http://localhost:8000/readyz
# Expected: {"status":"ready","checks":{"database":true}}

Access the Dashboard​

Open http://localhost:8000 in your browser to access the operator dashboard.

API Documentation​

Next Steps​

  1. Configure your first organization
  2. Register an agent
  3. Set up policies

Troubleshooting​

Services won't start​

# Check logs
docker compose logs

# Rebuild containers
make rebuild

Database connection errors​

# Check postgres is healthy
docker compose ps postgres

# Reset database
make db-reset

Port conflicts​

Edit .env to change ports:

BACKEND_PORT=8001
POSTGRES_PORT=5433