Table of contents
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 the Shieldlist Web UI 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
Version 0.1.0, the beta, in Debian packages from the project's APT repository (https://repo.lrob.net/apt/shieldlist/): a fresh controller has the free rule library to give, the public unblock page can live on a name of its own, the networks' abuse desks are mailed and their answers read, and the fleet's memory — recidivism, sharing, lists of offending subnets — is the controller's. Read What to expect in beta before running it for a fleet you cannot afford to fix. Log ingestion and fleet-wide detection 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 |
| Web UI | What the Web UI shows and lets you do |
| Abuse reports | Mails to the networks' abuse desks: who receives them, how the desk is found, what the mail and its X-ARF document say |
| API | Every endpoint, and shield as its client |
| How it flows | Configuration down, sanctions up and around, lifts, versions both ways |
| What to expect in beta | What is solid, what will move, what is not built yet, the known issues |
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.