feat: implement basic rate limiting by ip address

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [traefik](https://github.com/containous/traefik) | patch | `v3.7.12` -> `v3.7.13` |

> ❗ **Important**
>
> Release Notes retrieval for this PR were skipped because no github.com credentials were available.
> If you are self-hosted, please see [this instruction](https://github.com/renovatebot/renovate/blob/master/docs/usage/examples/self-hosting.md#githubcom-token-for-release-notes).

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xNzMuMSIsInVwZGF0ZWRJblZlciI6IjQxLjE3My4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbXX0=-->

Reviewed-on: #141
Co-authored-by: Renovate Bot <renovate@coopcloud.tech>

.env.sample

@@ -139,10 +139,14 @@ WRITE_TIMEOUT=0s
 #####################################################################
 
 ## Enable prometheus metrics collection
-## used used by the coop-cloud monitoring stack
-## BASIC_AUTH should also be enabled
+## Metrics are served unauthenticated on :8082, reachable only from
+## other services on the proxy network (e.g. monitoring-ng's Alloy,
+## which auto-discovers it via the prometheus.io/scrape label)
 #COMPOSE_FILE="$COMPOSE_FILE:compose.metrics.yml"
 #METRICS_ENABLED=1
+
+## Setting METRICS_FQDN also adds a public metrics endpoint (behind
+## basic auth). BASIC_AUTH should be enabled for this.
 #METRICS_FQDN=metrics.traefik.example.com
 
 #####################################################################
@@ -211,6 +215,8 @@ WRITE_TIMEOUT=0s
 ## Garage
 #COMPOSE_FILE="$COMPOSE_FILE:compose.garage.yml"
 #GARAGE_RPC_ENABLED=1
+#COMPOSE_FILE="$COMPOSE_FILE:compose.garage-admin.yml"
+#GARAGE_ADMIN_ENABLED=1
 
 ## Nextcloud Talk HPB
 #COMPOSE_FILE="$COMPOSE_FILE:compose.nextcloud-talk-hpb.yml"
@@ -235,3 +241,20 @@ WRITE_TIMEOUT=0s
 
 ## Access logs
 #COMPOSE_FILE="$COMPOSE_FILE:compose.access-log.yml"
+
+## Behind a reverse proxy
+#
+# YAML array of subnets from which Traefik's trusts the x-real-ip
+# header when behind a reverse proxy.
+#
+# https://doc.traefik.io/traefik/reference/install-configuration/entrypoints/#opt-forwardedHeaders-trustedIPs
+#TRUSTED_IPS="['10.13.12.1']" # 10.13.12.1 is an example
+
+## Rate limits
+# You can enable universal rate limits by setting RATE_LIMIT_EVERYTHING
+# to true, otherwise each app needs to export their own middleware labels.
+#
+# https://doc.traefik.io/traefik/reference/routing-configuration/http/middlewares/ratelimit/
+#RATE_LIMIT_EVERYTHING=false
+#RATE_LIMIT_AVERAGE=100
+#RATE_LIMIT_BURST=200

MAINTENANCE.md

@@ -3,20 +3,6 @@
 All contributions should be made via a pull request. This is to ensure a
 certain quality and consistency, that others can rely on.
 
-## Roles
-
-We differentiate between two roles:
-
-- **Maintainers** take responsibility for the recipe. They are listed in the
-  [README.md](./README.md), are members of the
-  [traefik maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/traefik-maintainers)
-  and fulfil the responsibilities described below.
-- **Contributors with merge access** Trusted people can open pull requests and merge them
-  themselves in the cases described in [Pull Requests](#pull-requests).
-  They are listed in the [README.md](./README.md).
-
-Being allowed to merge a pull request does not make somebody a maintainer.
-
 ## Maintainer Responsibilities
 
 A recipe maintainer has the following responsibilities:
@@ -25,74 +11,22 @@ A recipe maintainer has the following responsibilities:
 - Make image security updates within a week
 - Make image major updates every three months
 
-In order to fulfill these responsibilities a recipe maintainer:
+In order to fullfill these responsibilities a recipe maintainer:
 
 - Has to watch the repository (to get notifications)
 - Needs to make sure renovate is configured properly
 
 ## Pull Requests
 
-As a rule, a pull request can be merged once it has been approved by at least
-one maintainer other than its author. The exceptions below exist so that
-security fixes and routine updates don't get stuck waiting for a review.
-
-| Type of change | Approval needed |
-| --- | --- |
-| Security fix | No, can be merged immediately |
-| Regular update | No, after a review window of about one week |
-| Feature, extension or change of the default configuration | Yes, always |
-| Small change that can't break the recipe | No |
-
-### Security fixes
-
-If a pull request contains a relevant security fix, the person who opened it is
-allowed to merge it directly, without approval and without waiting.
-
-The same applies to a pull request that fixes an update which contains a
-security fix: if a version bump can't be merged as it is, because the new
-version needs changes to the configuration, then the pull request that
-makes that update work can be merged directly as well. Otherwise a broken
-update would block a security fix.
-
-Keep these pull requests as small as possible, so they contain nothing but what
-is needed to get the fix out.
-
-### Regular updates
-
-If a pull request rolls out a regular update, there is a time window of about
-one week for other maintainers to review it and to request changes. If no other
-maintainer is available within this time window, the person who opened it is
-allowed to merge it without approval.
-
-### Features, extensions and default configuration
-
-Any pull request that adds a feature or an extension, or changes the default
-configuration, needs an approval, no matter who opened it. These are the
-changes most likely to break existing deployments.
-
-### Small changes
-
-Small changes that definitely won't break the recipe can be merged without
-approval, for example:
-
-- a new environment variable that is commented out by default
-- a new `abra.sh` function
-- changes to the [README.md](./README.md)
-- writing new tests
-- configuring renovate
-
-If a pull request falls into more than one of these categories, the stricter
-rule applies. If you are unsure which category a pull request belongs to, ask
-for an approval.
-
-Even though it is okay to merge a pull request with a single approval, it is
-always better if all maintainers looked at the pull request and approved it.
+A pull request can be merged if it is approved by at least one maintainer. For
+pull requests opened by a maintainer they need to be approved by another
+maintainer. Even though it is okay to merge a pull request with one approval, it
+is always better if all maintainers looked at the pull request and approved it.
 
 ## Become a maintainer
 
 Everyone can apply to be a recipe maintainer:
-
 1. Watch the repository to always get updates
 2. Simply add your self to the list in the [README.md](./README.md) and open a new pull request with the change.
 3. Once the pull request gets merged you will be added to the [traefik maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/traefik-maintainers).
-4. Join the room [#cc-|-traefik-maintenance:matrix.org](https://matrix.to/#/%23cc-%7C-traefik-maintenance:matrix.org) and chat to other maintainers.
+4. Join the room [#cc-|-traefik-maintenance:matrix.org](#cc-|-traefik-maintenance:matrix.org) and chat to other maintainers.

abra.sh

@@ -1,4 +1,4 @@
-export TRAEFIK_YML_VERSION=v33
-export FILE_PROVIDER_YML_VERSION=v12
+export TRAEFIK_YML_VERSION=v37
+export FILE_PROVIDER_YML_VERSION=v14
 export ENTRYPOINT_VERSION=v5
 export ANUBIS_YML_VERSION=v1

compose.garage-admin.yml

@@ -0,0 +1,10 @@
+version: "3.8"
+services:
+  app:
+    environment:
+      - GARAGE_ADMIN_ENABLED
+    ports:
+      - target: 3903
+        published: 3903
+        protocol: tcp
+        mode: host

compose.metrics.yml

@@ -3,3 +3,9 @@ services:
   app:
     environment:
       - METRICS_ENABLED
+    deploy:
+      labels:
+        # lets monitoring-ng's Alloy auto-discover and scrape metrics-internal
+        # via the proxy network.
+        - "prometheus.io/scrape=true"
+        - "prometheus.io/port=8082"

compose.yml

@@ -3,7 +3,7 @@ version: "3.8"
 
 services:
   app:
-    image: "traefik:v3.7.10"
+    image: "traefik:v3.7.13"
     # Note(decentral1se): *please do not* add any additional ports here.
     # Doing so could break new installs with port conflicts. Please use
     # the usual `compose.$app.yml` approach for any additional ports
@@ -57,12 +57,12 @@ services:
         - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
         - "traefik.http.routers.${STACK_NAME}.service=api@internal"
         - "traefik.http.routers.${STACK_NAME}.middlewares=security@file"
-        - "coop-cloud.${STACK_NAME}.version=6.1.0+v3.7.10"
+        - "coop-cloud.${STACK_NAME}.version=6.2.0+v3.7.12"
         - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT}"
         - "backupbot.backup=${ENABLE_BACKUPS:-true}"
 
   socket-proxy:
-    image: lscr.io/linuxserver/socket-proxy:3.4.3
+    image: lscr.io/linuxserver/socket-proxy:3.4.4
     deploy:
       endpoint_mode: dnsrr
     environment:

file-provider.yml.tmpl

@@ -22,6 +22,11 @@ http:
       basicAuth:
         usersFile: "/run/secrets/usersfile"
     {{ end }}
+    ip-rate-limit:
+      rateLimit:
+        average: {{ or (env "RATE_LIMIT_AVERAGE") "100" }}
+        burst: {{ or (env "RATE_LIMIT_BURST") "200" }}
+        period: "1s"
     security:
       headers:
         frameDeny: true
@@ -32,6 +37,7 @@ http:
         stsSeconds: "31536000"
   {{ if eq (env "METRICS_ENABLED") "1" }}
   routers:
+    {{ if ne (env "METRICS_FQDN") "" }}
     traefik-metrics:
       rule: "Host(`{{ env "METRICS_FQDN" }}`)"
       entrypoints:
@@ -41,6 +47,14 @@ http:
       middlewares:
         - basicauth@file
       service: prometheus@internal
+    {{ end }}
+    # reachable from other services on the proxy network only (this port
+    # isn't published to the host), without auth
+    traefik-metrics-internal:
+      rule: "PathPrefix(`/`)"
+      entrypoints:
+        - metrics-internal
+      service: prometheus@internal
   {{ end }}
 
 tls:
@@ -61,4 +75,4 @@ tls:
   certificates:
     - certFile: /run/secrets/ssl_cert
       keyFile: /run/secrets/ssl_key
-  {{ end }}
+  {{ end }}

release/6.2.0+v3.7.12

@@ -0,0 +1 @@
+1. compose.metrics.yml now adds prometheus.io/scrape labels so services like monitoring-ng can automatically discover and scrape Traefik's metrics.

traefik.yml.tmpl

@@ -48,6 +48,14 @@ entrypoints:
           to: web-secure
   web-secure:
     address: ":443"
+{{ if ne (env "TRUSTED_IPS") "" }}
+    forwardedHeaders:
+      trustedIPs: {{ env "TRUSTED_IPS" }}
+{{ end }}
+{{ if eq (env "RATE_LIMIT_EVERYTHING") "true" }}
+    middlewares:
+      - "ip-rate-limit@file"
+{{ end }}
     transport:
       respondingTimeouts:
         readTimeout: {{ env "READ_TIMEOUT" }}
@@ -75,6 +83,10 @@ entrypoints:
   garage-rpc:
     address: ":3901"
   {{- end }}
+  {{- if eq (env "GARAGE_ADMIN_ENABLED") "1" }}
+  garage-admin:
+    address: ":3903"
+  {{- end }}
   {{- if eq (env "FOODSOFT_SMTP_ENABLED") "1" }}
   foodsoft-smtp:
     address: ":2525"
@@ -127,6 +139,10 @@ entrypoints:
   onion:
     address: ":9052"
   {{- end }}
+  {{- if eq (env "METRICS_ENABLED") "1" }}
+  metrics-internal:
+    address: ":8082"
+  {{- end }}
 
 ping:
   entryPoint: web