Skip to main content
This guide covers all the commands you’ll need to manage your self-hosted Bilanc deployment.

Make Commands

The Makefile provides convenient shortcuts for common operations:

Starting Bilanc

CommandDescription
make rBuild and start all containers in detached mode
make runSame as make r
make upBuild and start all containers in foreground (with logs)
# Start Bilanc (detached - recommended for production)
make r

# Start Bilanc with live logs (useful for debugging)
make up

Stopping Bilanc

CommandDescription
make dStop and remove all containers
make downSame as make d
# Stop all containers
make down

Rebuilding

CommandDescription
make recomposeStop, rebuild, and restart all containers
# Rebuild after configuration changes
make recompose

Docker Compose Commands

For more granular control, use Docker Compose directly:

Container Management

# Start all services
docker compose up -d

# Stop all services
docker compose down

# Restart a specific service
docker compose restart api

# Rebuild and start
docker compose up -d --build

Viewing Logs

# View logs for all services
docker compose logs

# View logs for a specific service
docker compose logs api
docker compose logs frontend
docker compose logs dagster_daemon

# Follow logs in real-time
docker compose logs -f

# Follow logs for a specific service
docker compose logs -f api

# View last 100 lines
docker compose logs --tail 100 api

Service Status

# List running containers
docker compose ps

# Check container health
docker compose ps --format "table {{.Name}}\t{{.Status}}"

Executing Commands

# Open a shell in a container
docker compose exec api bash
docker compose exec frontend sh

# Run a one-off command
docker compose exec api python -c "print('hello')"

Service Names

When working with Docker Compose, use these service names:
ServiceName
Dashboardfrontend
API Serverapi
Dagster Webserverdagster_webserver
Dagster Daemondagster_daemon
Celery Workerworker
Redis Brokerbroker

Common Operations

Restart After Configuration Change

After modifying .env or tenant_config.yaml:
make recompose

Check Pipeline Status

# View Dagster daemon logs
docker compose logs -f dagster_daemon

# Or open the Dagster UI
open http://localhost:4000

Debug API Issues

# View API logs
docker compose logs -f api

# Check API health
curl http://localhost:8000/health

Debug Frontend Issues

# View frontend logs
docker compose logs -f frontend

# Check if frontend is responding
curl http://localhost:3000

Clear All Data (Caution)

This will delete all data including the database. Only use for fresh installs.
# Stop and remove containers, networks, and volumes
docker compose down -v

Updating Bilanc

When a new version is available:
# Pull the latest images
docker compose pull

# Rebuild and restart
make recompose
Always test updates in a staging environment before applying to production.

Troubleshooting Commands

Check Container Status

# See which containers are running
docker compose ps

# See all containers (including stopped)
docker compose ps -a

Inspect Container

# View container details
docker compose inspect api

# View container resource usage
docker stats

Force Rebuild

If you’re experiencing issues after an update:
# Remove all containers and rebuild from scratch
docker compose down
docker compose build --no-cache
docker compose up -d

Database Access

# Connect to PostgreSQL
docker compose exec db psql -U bilanc -d bilanc

# Or if using an external database
psql -h your_host -U your_user -d bilanc