Skip to content

Install With Docker Compose

Docker Compose is the fastest way to get Alien Giraffe running for local development, evaluation, or a small single-host deployment. The repository ships a Compose-based stack — use it instead of writing a custom docker-compose.yaml.

See Installation for how this compares to the other deployment types, and for the shared a10e.toml configuration reference.

  • Docker 20.10+
  • 2+ CPU cores, 4+ GB RAM, 20+ GB storage (see System Requirements for production sizing)
git clone https://github.com/aliengiraffe/env-manager.git
cd env-manager
task env:setup

This copies .env.example to .env and prepares the local environment files the Compose stack and dashboard read from.

docker compose up -d --build

This starts the repo-owned Compose stack (compose.yaml), which includes:

  • PostgreSQL
  • the migration job
  • connector (config from config/a10e.compose.toml)
  • the dashboard (config from config/dashboard.compose.env)

Default local URLs:

  • API: http://localhost:8080/v1
  • Dashboard: http://localhost:3000

Useful lifecycle commands:

# View logs
docker compose logs -f
# Stop the stack
docker compose down
# Stop the stack and reset the local database
docker compose down -v

The Compose stack also supports optional test-only integrations through compose.test.yaml, intentionally excluded from the default install flow.

  1. Open http://localhost:3000.

  2. Create the first local user from the setup screen.

  3. In the dashboard, open Admin → Data Sources Config and click Add Datasource.

  4. Fill in:

    • Name: libenzo
    • Type: S3
    • Bucket: libenzo-examples
    • Region: us-west-2
    • Target: processed/2025/analytics_summary.parquet

    See Configure Data Sources for the full form reference.

  5. Run the catalog scanner from the repo root:

docker compose exec connector /connector catalog scan -config /config/a10e.toml
  1. Return to the dashboard and refresh the catalog page. The datasource should now show the discovered dataset and can be used in request templates and requests. See Catalog Scanning for the full scanner reference.
docker compose ps
curl http://localhost:8080/v1/healthcheck

All containers should show as running/healthy, and the health check should return {"success":true,"message":"Service is healthy"}. See Operations: Health Checks & Backups for ongoing monitoring.

git pull
docker compose up -d --build

Continue with Configure Data Sources, or see Installation for the full post-install checklist.