Developers
For people building tools that work with LibrePortal: access keys, the read-only status documents, events and webhooks, and how to share CrowdSec.
These pages are for people who write software that runs next to a LibrePortal server or talks to it. If you only run a server, you will not need them.
Everything here is a plain command with --json or a read-only address under /api/v1/, both with stable field names. A tool never needs your login: it uses an access key.
- API keys and scopes: how a tool signs in, and which scope opens which address.
- Maintenance status: is a restart or Docker update waiting, is the server busy, when is the next quiet time.
- Security status: whether CrowdSec is installed and running, and what it is doing.
- Events and webhooks: read the log of what LibrePortal did, or have it tell you the moment it happens.
- Commands for other software: set the address an app advertises, see which other apps a command recreated, preview a change with
--dry-run, and keep firewall rules. - CrowdSec for other software: add your own log sources, never-ban ranges and collections without a second intrusion tool.
- Building from source: build the website and this guide on your own computer, and where the Android apps and the product live.
Administrators have their own pages for the same features: Access keys to make and revoke keys, Extra firewall rules for rules a tool can hand to LibrePortal, and The command line.