Skip to main content

Quickstart

Run Yard locally in under a minute. Demo login:

admin@yard.local
yard-admin

Local server​

go run ./cmd/yard

Open http://127.0.0.1:8080.

In another terminal, start the included simulator:

export YARD_SIMULATOR_TOKEN=$(cat data/simulator.token)
go run ./cmd/simulator

First-use path: seeded workspace → simulator (or Device Agent gateway) → discover assets → inspect health → temperature / missed heartbeat opens an incident (with severity policy + runbook) → assign a work order → record resolution on the asset timeline.

Console development​

cd web && npm install && npm run dev

Vite proxies /api to :8080.

Docker Compose​

docker compose up --build

PostgreSQL is optional:

docker compose --profile postgres up --build

Remote lab deploy​

Same one-command pattern as Fabric/Nodra:

./scripts/ship sus@HOST              # quick redeploy
./scripts/ship sus@HOST --full       # first install + firewall
./scripts/ship sus@HOST --with-sim   # also start the simulator

Open http://HOST:18080 (default lab port). Smoke from your laptop:

YARD_URL=http://HOST:18080 ./scripts/verify-remote.sh

See Deploy for details, including backups.

What's next​

Related articles

ArchitectureAsset model and boundaries→Console featuresBulk IO, map clustering, runbooks, users, API keys→ConnectorsIngest and Device Agent→APIFull route reference, plus Go and TypeScript SDKs→Full feature catalogdocs/ROADMAP.md→