How to install WoWyrd
WoWyrd runs in your own environment with Docker Compose. There is no hosted service to sign up for. This page gives the steps and the main commands.
The full runbook, with every option, is INSTALL.md in the public wowyrd-pub repository. If this page and INSTALL.md differ, follow INSTALL.md.
Choose a profile
A pilot needs the evidence report, so a pilot uses Full.
| Profile | Use it for | Containers |
|---|---|---|
| Full (PostgreSQL + Redis) | A pilot on your own data, with the evidence report. Linux host. On macOS, for an evaluation or a demo only. | 4 |
| Lite (embedded SQLite) | A quick look at live scoring and the case queue. No evidence report. Linux or macOS. | 2 |
Install flow
Steps
You need Docker and Docker Compose.
Request an access token
The images are private. Ask us for a registry token with read-only package access
(read:packages) through the pilot request.
Log in to the image registry
Once per machine.
echo "$WOWYRD_PAT" | docker login ghcr.io -u wowyrd --password-stdin
The registry checks the token only. The user name can be any value, and you don't need a GitHub account of your own.
Verify the images
Before the first pull, check that the images come from WoWyrd: with a cosign signature or with the image digests on the Releases page, depending on the version. INSTALL.md step 3 says which one applies to your version.
Configure
cp .env.example .env
In .env, set WOWYRD_VERSION (without the leading “v”),
POSTGRES_PASSWORD and API_KEYS. On a host that is reachable from
the internet, also set POSTGRES_BIND=127.0.0.1 and REDIS_BIND=127.0.0.1,
so the database and cache ports stay closed.
Start
Full on Linux (pilot)
docker compose up -d
Full on macOS (evaluation or demo)
docker compose -f docker-compose.yml -f docker-compose.macos.yml up -d
Lite (quick look)
docker compose -f docker-compose.yml -f docker-compose.lite.yml up -d wowyrd-app wowyrd-dashboard
For Lite, POSTGRES_PASSWORD can be any placeholder value.
Check that it runs
curl http://localhost:8090/health
Open the dashboard
Open http://localhost:3000. WoWyrd starts in observe mode
(ENFORCEMENT_MODE=observe): it records what it would do and blocks nothing.
Evidence appears as traffic is evaluated.
This is a guided pilot. Write to vitaliy@wowyrd.net, and we will help you through it.