Installation
The quickest way to run Windrunner is Docker Compose.
Run with Docker Compose (recommended)
Prerequisites: Docker with Compose v2. No other tooling required.
mkdir windrunner && cd windrunner
curl -fsSL https://raw.githubusercontent.com/shzlw/windrunner/main/server/docker-compose.yml -o docker-compose.yml
curl -fsSL https://raw.githubusercontent.com/shzlw/windrunner/main/server/.env.example -o .env
At minimum, change these two default passwords in .env:
POSTGRES_PASSWORD=windrunner
...
WINDRUNNER_BOOTSTRAP_SUPERADMIN_PASSWORD=changeme
Then:
docker compose up -d
Then open http://localhost:8066 and sign in with the
bootstrap superadmin from your .env. The default credentials are admin and
the value of WINDRUNNER_BOOTSTRAP_SUPERADMIN_PASSWORD.
Data lives in the pgdata Docker volume. To upgrade, pull the new image and
run docker compose up -d; Flyway applies migrations automatically.
The app image supports both linux/amd64 and linux/arm64 hosts.
Building from source
For prerequisites, database setup, local configuration, and troubleshooting, see Build from source.
See Configuration for all environment variables.
Use the CLI
The optional Windrunner CLI supports terminal workflows and automation.