README: compose example for the open internet, with common waf settings (closes #381)
check / check (push) Waiting to run
check / check (push) Waiting to run
A new example puts one gitea behind traefik, rproxy and waf. waf sets nine settings most sites use, then eight more commented out, each with what it does and when to set it. Model: opus-5-5
This commit was merged in pull request #413.
This commit is contained in:
1 parent
9f42460f70
commit
eb48796f27
1 file changed
+138
-2
@@ -420,8 +420,8 @@ full, and the limits that are fixed rather than settings.
|
||||
Each example is a complete `compose.yaml`. `smallwebwaf` is the tag
|
||||
`make docker` gives the image; on another host, use the name you pushed it
|
||||
under, by digest. Docker Compose puts the services on a private network of its
|
||||
own, where each reaches the others by service name. Each example publishes
|
||||
`rproxy`'s port on the host, for trying it out.
|
||||
own, where each reaches the others by service name. Each example but "On the
|
||||
open internet" publishes `rproxy`'s port on the host, for trying it out.
|
||||
|
||||
### Smallest setup
|
||||
|
||||
@@ -453,6 +453,142 @@ volumes:
|
||||
waf-state:
|
||||
```
|
||||
|
||||
### On the open internet
|
||||
|
||||
One gitea at `git.example.com`, with traefik in front of `rproxy`. traefik gets
|
||||
the certificate from Let's Encrypt and is the only service with published ports.
|
||||
`waf` sets what most sites set. More `waf` settings follow, commented out, each
|
||||
with what it does and when to set it.
|
||||
|
||||
```yaml
|
||||
services:
|
||||
traefik:
|
||||
# traefik v3.7.19, 2026-11-13
|
||||
image: traefik@sha256:a6c0194dda77bcb804824580f36fa7edc56e315b1acfe933366c8b52844a78a4
|
||||
restart: unless-stopped
|
||||
command:
|
||||
- --providers.docker=true
|
||||
- --providers.docker.exposedByDefault=false
|
||||
- --entryPoints.web.address=:80
|
||||
- --entryPoints.websecure.address=:443
|
||||
# Redirect plain HTTP to HTTPS.
|
||||
- --entryPoints.web.http.redirections.entryPoint.to=websecure
|
||||
- --entryPoints.web.http.redirections.entryPoint.scheme=https
|
||||
# A Let's Encrypt certificate for each site, by the TLS-ALPN
|
||||
# challenge on port 443.
|
||||
- --entryPoints.websecure.http.tls.certResolver=le
|
||||
- --certificatesResolvers.le.acme.email=hostmaster@example.com
|
||||
- --certificatesResolvers.le.acme.storage=/letsencrypt/acme.json
|
||||
- --certificatesResolvers.le.acme.tlsChallenge=true
|
||||
# Give a request 10 minutes to arrive, rather than 1, for the
|
||||
# large git pushes the rproxy lines below accept.
|
||||
# - --entryPoints.websecure.transport.respondingTimeouts.readTimeout=600s
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
- acme:/letsencrypt
|
||||
|
||||
app:
|
||||
# Your app: here a gitea, which listens on port 3000.
|
||||
image: registry.example/app@sha256:0000000000000000000000000000000000000000000000000000000000000000
|
||||
restart: unless-stopped
|
||||
|
||||
rproxy:
|
||||
image: smallwebwaf
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
SWW_RPROXY_WAF_BACKEND: http://waf:8080
|
||||
SWW_RPROXY_UPSTREAM_URL: http://app:3000
|
||||
# Accept git pushes up to 1 GiB, rather than 100 MiB, sent in
|
||||
# up to 10 minutes, rather than 1, with traefik's readTimeout
|
||||
# line above.
|
||||
# SWW_RPROXY_MAX_REQUEST_SIZE: 1G
|
||||
# SWW_RPROXY_MAX_REQUEST_TIME_MS: "600000"
|
||||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.http.routers.git.rule=Host(`git.example.com`)
|
||||
- traefik.http.routers.git.entryPoints=websecure
|
||||
- traefik.http.services.git.loadBalancer.server.port=8080
|
||||
|
||||
waf:
|
||||
image: smallwebwaf
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
SWW_COMMAND: waf
|
||||
# The name in every log line, alert and metric. The default,
|
||||
# the container's host name, is a random id under Compose.
|
||||
SWW_WAF_INSTANCE_NAME: host1/waf
|
||||
# The app each hostname serves. Only that app's fixes to the
|
||||
# Core Rule Set apply there.
|
||||
SWW_WAF_APPS: git.example.com:gitea
|
||||
# Monitoring skips every check.
|
||||
SWW_WAF_ALLOW_NETS: 192.0.2.10
|
||||
# The office and the CI runner, which would exceed the rate
|
||||
# limits, are never rate limited.
|
||||
SWW_WAF_RATE_LIMIT_EXEMPT_NETS: 203.0.113.0/24,198.51.100.7
|
||||
# WordPress paths, which only scanners ask a gitea for. One
|
||||
# request for one bans the client.
|
||||
SWW_WAF_TRAP_PATHS: /wp-login.php,/xmlrpc.php
|
||||
# Spamhaus's list of netblocks hijacked or leased by
|
||||
# criminals. Their clients are refused.
|
||||
SWW_WAF_BLOCKLIST_URLS: https://www.spamhaus.org/drop/drop.txt
|
||||
# The token for the ban endpoints, to lift a ban without
|
||||
# editing bans.json.
|
||||
SWW_WAF_ADMIN_TOKEN_FILE: /etc/sww/tokens/admin
|
||||
# Alerts, such as one for each ban, to an ntfy topic.
|
||||
SWW_WAF_ALERT_NTFY_URL: https://ntfy.example.com/smallwebwaf
|
||||
|
||||
# Refuse nothing and ban no one, for the first days. Each log
|
||||
# line says what enforce mode would have done.
|
||||
# SWW_WAF_MODE: observe
|
||||
# The access token for an ntfy topic that is not public.
|
||||
# SWW_WAF_ALERT_NTFY_TOKEN_FILE: /etc/sww/tokens/ntfy
|
||||
# The token for /_sww/metrics, for Prometheus. Unset, the
|
||||
# metrics are off.
|
||||
# SWW_WAF_METRICS_TOKEN_FILE: /etc/sww/tokens/metrics
|
||||
# 600 requests an hour rather than 1500, to ban slower
|
||||
# scrapers. A fast human reader can reach it too.
|
||||
# SWW_WAF_RATE_LIMIT_PER_HOUR: "600"
|
||||
# A quarter of every limit for clients in two hosting
|
||||
# networks, where scrapers run rather than people.
|
||||
# SWW_WAF_TAG_LIMIT_PERCENT: asn=14061:25,asn=16276:25
|
||||
# For a site only for people in a few countries. Clients
|
||||
# elsewhere are refused, and so are any the lookup cannot place.
|
||||
# SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES: de,at,ch
|
||||
# Close a refused request's connection rather than answer
|
||||
# 403. traefik then answers 502, so a scraper cannot tell a
|
||||
# ban from a broken site.
|
||||
# SWW_WAF_BAN_RESPONSE: close
|
||||
# A copy of every log line to a syslog server.
|
||||
# SWW_WAF_LOG_REMOTE_URL: syslog+tls://logs.example.com:6514
|
||||
volumes:
|
||||
- waf-state:/var/lib/sww
|
||||
- /srv/sww/tokens:/etc/sww/tokens:ro
|
||||
|
||||
volumes:
|
||||
acme:
|
||||
waf-state:
|
||||
```
|
||||
|
||||
Change these before the first start:
|
||||
|
||||
- `git.example.com`, in the router rule and in `SWW_WAF_APPS`;
|
||||
- the email address for Let's Encrypt;
|
||||
- the ntfy topic's URL;
|
||||
- the app's image and port;
|
||||
- the netblocks, which are documentation addresses.
|
||||
|
||||
Make the admin token file first, as for any token file:
|
||||
|
||||
```sh
|
||||
mkdir -p /srv/sww/tokens
|
||||
openssl rand -hex 32 > /srv/sww/tokens/admin
|
||||
chown 65532:65532 /srv/sww/tokens/admin
|
||||
chmod 0400 /srv/sww/tokens/admin
|
||||
```
|
||||
|
||||
### Custom per-address limits
|
||||
|
||||
For a site with no API:
|
||||
|
||||
Reference in new issue
Block a user