Self-host CrowdSec Local API on a VPS
Collaborative security engine run here as the local API that other agents and bouncers register with. The log reading agent and the online API are switched off.
levelrail-cli templates deploy crowdsec --name my-crowdsecSpecification
- Status
- Listed
- Category
- Security
- Services
- crowdsec
- Ports
- 8080
- Volumes
- 2
- Memory
- about 256 MiB
- arm64
- unknown
- amd64
- unknown
- Settings to fill in
- none
- License
- Permissive license, MIT
- Listing
- Community template
About CrowdSec Local API
Collaborative security engine run here as the local API that other agents and bouncers register with. The log reading agent and the online API are switched off.
What it deploys
CrowdSec Local API runs as one service in a single Compose app, listening on port 8080, with 2 named volume mounts.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| crowdsec | crowdsecurity/crowdsec | v1.8.2 | 8080 | config -> /etc/crowdsecdata -> /var/lib/crowdsec/data |
Before you install
- CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
- Listed. It is in the catalog. Back up the data volume before changing an image tag.
Settings and environment
You do not have to fill in anything. Values are never shown here.
| Service | Variable | Value |
|---|---|---|
| crowdsec | DISABLE_AGENT | Preset by the template |
| crowdsec | DISABLE_ONLINE_API | Preset by the template |
First run
- Register an agent or bouncer with cscli machines add or cscli bouncers add inside the container, then point it at this address.
Install CrowdSec Local API on a VPS
-
Install Levelrail on a fresh VPS
Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.
curl -fsSL https://levelrail.com/install.sh | sudo sh -
Sign in
Open the setup link, choose a password, then log the CLI in. The CLI install command is
curl -fsSL https://levelrail.com/install-cli.sh | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get crowdsec -
Deploy it
This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.
levelrail-cli templates deploy crowdsec --name my-crowdsec
Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then CrowdSec Local API.
Docs and upstream
More in Security
- CryptgeonA self-destructing note and file sharing service inspired by PrivNote, with end-to-end encryption.
- DexOpenID Connect identity provider that fronts other identity sources. The install form carries config.yaml as an editable file, so it starts with a local database and the issuer address you choose.
- CapA lightweight, privacy-friendly proof-of-work CAPTCHA, an alternative to reCAPTCHA or hCaptcha.
- authentikAn identity provider and SSO platform with flows, policies, and support for OIDC, SAML, LDAP, and proxy auth.
- AutheliaSingle sign-on and two-factor portal. The admin user is created at first boot from a generated password (visible in the service environment settings, never on a process command line); more users go in /data/users.yml. Sessions are scoped to this portal's own host, so widen the cookie domain in /config/configuration.yml before protecting other apps. One-time codes are written to /data/notification.txt.
- AnubisA reverse proxy that makes clients pass a small proof of work before reaching your site, which blocks most scraper bots. Sits in front of one upstream you choose. The signing key is generated for you.