Skip to main content

Docker Compose

For development and testing, Docker Compose provides an easy way to run DBBat with all dependencies.

docker-compose.yml​

services:
  postgres:
    image: postgres:16-alpine
    environment:
      POSTGRES_USER: dbbat
      POSTGRES_PASSWORD: dbbat
      POSTGRES_DB: dbbat
    ports:
      - "5000:5432"
    volumes:
      - postgres_data:/var/lib/postgresql/data
      - ./init.sql:/docker-entrypoint-initdb.d/init.sql:ro

  dbbat:
    image: ghcr.io/fclairamb/dbbat
    depends_on:
      - postgres
    environment:
      DBB_DSN: postgres://dbbat:dbbat@postgres:5432/dbbat?sslmode=disable
      DBB_KEY: ${DBB_KEY:-YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY=}
      DBB_LISTEN_PG: ":5434"
      DBB_LISTEN_API: ":8080"
    ports:
      - "5001:5434"  # Proxy port
      - "8080:8080"  # API port

volumes:
  postgres_data:

Initial Setup Script (init.sql)​

Create a init.sql file to set up a sample target database:

-- Create a target database for testing
CREATE DATABASE target;

\c target

CREATE TABLE test_data (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100),
    value INTEGER,
    created_at TIMESTAMP DEFAULT NOW()
);

INSERT INTO test_data (name, value) VALUES
    ('Test 1', 100),
    ('Test 2', 200),
    ('Test 3', 300);

Usage​

Start the services:

docker-compose up -d

Login and Get a Token​

# Login to get a session token
TOKEN=$(curl -s -X POST http://localhost:8080/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "admin"}' | jq -r '.token')

Create a Database Configuration​

# First, configure the target database
curl -X POST http://localhost:8080/api/v1/databases \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "target_db",
    "description": "Target database for testing",
    "host": "postgres",
    "port": 5432,
    "database_name": "target",
    "username": "dbbat",
    "password": "dbbat",
    "ssl_mode": "disable"
  }'

Create a Test User and Grant Access​

# Create a test user
curl -X POST http://localhost:8080/api/v1/users \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"username": "testuser", "password": "testpass", "roles": ["connector"]}'

# Get the user UID and database UID from the responses above, then create a grant
curl -X POST http://localhost:8080/api/v1/grants \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "<user-uid>",
    "database_id": "<database-uid>",
    "controls": [],
    "starts_at": "2024-01-01T00:00:00Z",
    "expires_at": "2030-01-01T00:00:00Z"
  }'
note

An empty controls array means full write access. Use ["read_only"] for read-only access.

Connect Through the Proxy​

PGPASSWORD=testpass psql -h localhost -p 5001 -U testuser -d target_db

Stopping​

docker-compose down

To also remove volumes:

docker-compose down -v

Next Steps​