Docker Compose deployment
Start all Clouisle services on a single server
Docker Compose suits single-server deployments. Requires Docker and Docker Compose v2.
Guided installer
curl -fsSL https://raw.githubusercontent.com/clouisle/Clouisle/main/deploy/install.sh | bashSelect Docker Compose, confirm the install directory and domain, and the installer downloads files, generates strong secrets, validates the Compose file, pulls images, and starts the services.
Non-interactive install (skips prompts, uses defaults):
CLOUISLE_DEPLOYMENT=docker CLOUISLE_YES=1 curl -fsSL https://raw.githubusercontent.com/clouisle/Clouisle/main/deploy/install.sh | bashThe default install directory is /opt/clouisle.
Manual installation
cd deploy
cp .env.example .env
internal_api_token="$(openssl rand -hex 32)"
sed -i.bak "s/^INTERNAL_API_TOKEN=.*/INTERNAL_API_TOKEN=${internal_api_token}/" .env
rm .env.bak
unset internal_api_token
docker compose pull
docker compose up -dmacOS BSD sed has different arguments from GNU sed; on macOS, edit .env directly or use the installer to generate the Token.
Check the services
docker compose ps
docker compose logs -f api
curl http://localhost:8000/api/v1/healthConfigure the external reverse proxy so /api/* goes to api:8000 and / goes to frontend:3000. The browser entry point defaults to http://localhost:3000.
Initialization
Tortoise ORM creates and migrates tables automatically at API startup (no Alembic). The first registered user automatically becomes the Super Admin.
Common operations
docker compose logs -f worker
docker compose restart api
docker compose up -d --scale worker=4
docker compose up -d --scale sandbox-worker=2
docker compose downbeat must stay at one replica. docker compose down -v deletes data volumes; complete a backup before running it.
How is this guide?