SEC.01

The playbook

The run starts read-only: the recon probes decide what happens next. The steps that follow are adapted to the distribution and state found — a real machine is rarely clean.

  1. 01reconDocker Engine + compose plugin installed and service active?
  2. 02reconalready deployed? existing containers, volumes and /opt/woodpecker (→ do not regenerate secrets)
  3. 03reconports 8000 (local Woodpecker), 80/443 (reverse proxy) free, or held by what?
  4. 04reconreverse proxy already in place (Caddy/nginx) to reuse?
  5. 05recondistro, version, architecture and package manager (apt-get → Debian/Ubuntu, dnf → RHEL/Fedora/Rocky/Alma)
  6. 06reconfirewall active (ufw/firewalld) → open 80/443 only
  7. 07reconat least 1 GB of RAM and a few GB free
  8. 08actInstall Docker Engine (if missing)verify
  9. 09actGenerate the secretsverify
  10. 10actWrite /opt/woodpecker/compose.yamlverify
  11. 11actStart Woodpeckerverify
  12. 12actHTTPS reverse proxy for ${domain}verify

SEC.02

What it verifies

Each step ships its own check. The run only moves on when the check passes, so what the recipe reports as done is what is actually on the server.

  1. 01Install Docker Engine (if missing)Verified bysystemctl is-active docker && docker compose version
  2. 02Generate the secretsVerified bystat -c "%a %n" /opt/woodpecker/server.env /opt/woodpecker/agent.env
  3. 03Write /opt/woodpecker/compose.yamlVerified bydocker compose -f /opt/woodpecker/compose.yaml config -q && echo ok
  4. 04Start WoodpeckerVerified bycurl -s -o /dev/null -w '%{http_code}' http://127.0.0.1:8000/healthz
  5. 05HTTPS reverse proxy for ${domain}Verified bycurl -s -o /dev/null -w '%{http_code}' https://${domain}/healthz

SEC.03

Guardrails

Non-negotiable instructions the run must respect, whatever it finds on the server.

OAuth secrets and the agent secret are never displayed (no cat of the .env files) and never regenerated if they exist. Port 8000 stays on 127.0.0.1; only the HTTPS proxy is public. Registration closed (WOODPECKER_OPEN=false): the agent has access to the Docker socket, so any user can run code as root. OAuth callback to declare in the forge: https://<domain>/authorize.

SEC.04

Variables

What you choose before launching — the recipe fills in the rest.

NameMeaning
${domain}Domain
${forge}Forge
${forge_url}Forge URL (Gitea/Forgejo/GitLab)
${oauth_client}OAuth client ID
${oauth_secret}OAuth client secret
${admin}Admin account (forge username)

SEC.05

How a recipe runs in Servor

Servor is zero-knowledge: the platform cannot execute anything on its own. When you launch this recipe, a run reads the reconnaissance, plans the steps and asks for your approval. Each approved command is signed by your browser — with a key the server never sees — then relayed verbatim to the agent, which verifies the signature locally before executing.

recipe — fail2ban_setup150+ in catalogue
security4 steps · low risk · idempotentrun
reconsshd present? ufw active? existing jails?✓
actinstall fail2ban · write default jails✓
actenable service · restart sshd (safe)✓
verifytest ban 60s · jails active · sshd alive✓

search by intent — type “firewall”, get ufw

  • 01Read-only reconnaissance before any change
  • 02Every command signed by your browser, approved by you
  • 03Each step verified before the run moves on, every run kept in the history

SEC.06

Deploy on Servor button

Maintain Woodpecker CI or a project that needs it? Put this button in your README or on your site: one click and your users install it on their own server.

Deploy on ServorDark background
Deploy on ServorLight background
[![Deploy on Servor](https://servor.app/badges/deploy-on-servor.svg)](https://servor.app/deploy/install-woodpecker)

SEC.07

Verified recipe

Run this recipe on your server

Connect a server, launch the recipe, and approve each step as Servor executes and verifies it. Free plan, no card required.