5 Home
Robin edited this page 2026-08-22 15:15:06 +00:00

Shieldlist controller

The central service for a fleet of Shieldlist agents. It holds the fleet's configuration as plain files, assembles what each machine should run and pushes it the moment it changes, records every ban the agents decide and hands them to the rest of the fleet, carries the operator's decisions — lift, exempt, settle a machine, edit a rule — back to the machines within seconds, and shows all of it in a console and through an API. Agents keep defending their machines when the controller is away.

files (parsers, rules, policies, exemptions, agents/<host>.yaml)
   → assembled per machine → pushed to the agent → applied in place
agent's decisions → recorded → redistributed to the fleet → shown, lifted, exempted

Prerelease series 0.0.x, in Debian packages from the project's APT repository (https://repo.lrob.net/apt/shieldlist/). Log ingestion, fleet-wide detection and controller-side abuse reporting come next; the protocol is versioned and additive from here on.

Pages

Getting started Install, the first person, rules, the first machine — start here
Installing The reference: the package, and by hand on other systems
Configuration controller.yaml, one file per machine, overrides and levels, published allow lists
Console What the web console shows and lets you do
API Every endpoint, and shield as its client
How it flows Configuration down, sanctions up and around, lifts, versions both ways

In the repositories

Specification Vocabulary, requirements and open decisions — the authority
Configuration reference Every key, the agent's files and the controller's
The protocol What agent and controller say to each other
Agent wiki The program on the machines — and its Enrolment page

Credits: the data, lists, map and software Shieldlist builds on are credited on the Credits page.