feat: error pages

See coop-cloud/organising#115 (comment).

.drone.yml

@@ -3,12 +3,10 @@ kind: pipeline
 name: deploy to swarm-test.autonomic.zone
 steps:
   - name: deployment
-    image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest
+    image: decentral1se/stack-ssh-deploy:latest
     settings:
       host: swarm-test.autonomic.zone
       stack: traefik
-      networks:
-       - proxy
       deploy_key:
         from_secret: drone_ssh_swarm_test
     environment:
@@ -24,17 +22,11 @@ trigger:
     - master
 ---
 kind: pipeline
-name: generate recipe catalogue
+name: recipe release
 steps:
   - name: release a new version
-    image: plugins/downstream
+    image: thecoopcloud/drone-abra:latest
     settings:
-      server: https://build.coopcloud.tech
+      command: recipe traefik release
-      token:
+      deploy_key:
-        from_secret: drone_abra-bot_token
+        from_secret: abra_bot_deploy_key
-      fork: true
-      repositories:
-        - coop-cloud/auto-recipes-catalogue-json
-
-trigger:
-  event: tag

.env.sample

@@ -1,6 +1,4 @@
 TYPE=traefik
-TIMEOUT=300
-ENABLE_AUTO_UPDATE=true
 
 DOMAIN=traefik.example.com
 LETS_ENCRYPT_ENV=production
@@ -47,34 +45,13 @@ COMPOSE_FILE="compose.yml"
 #SECRET_GANDIV5_API_KEY_VERSION=v1
 
 #####################################################################
-# Manual wildcard certificate insertion                             #
+# Keycloak log-in                                                   #
-#####################################################################
-
-# Set wildcards = 1, and uncomment compose_file to enable.
-# Create your certs elsewhere and add them like:
-# abra app secrets insert {myapp.example.coop} ssl_cert v1 "$(cat /path/to/fullchain.pem)"
-# abra app secrets insert {myapp.example.coop} ssl_key v1 "$(cat /path/to/privkey.pem)"
-#WILDCARDS_ENABLED=1
-#SECRET_WILDCARD_CERT_VERSION=v1
-#SECRET_WILDCARD_KEY_VERSION=v1
-#COMPOSE_FILE="$COMPOSE_FILE:compose.wildcard.yml"
-
-#####################################################################
-# Authentication                                                    #
 #####################################################################
 
 ## Enable Keycloak
 #COMPOSE_FILE="$COMPOSE_FILE:compose.keycloak.yml"
 #KEYCLOAK_MIDDLEWARE_ENABLED=1
 #KEYCLOAK_TFA_SERVICE=traefik-forward-auth_app
-#KEYCLOAK_MIDDLEWARE_2_ENABLED=1
-#KEYCLOAK_TFA_SERVICE_2=traefik-forward-auth_app
-
-## BASIC_AUTH
-## Use httpasswd to generate the secret
-#COMPOSE_FILE="$COMPOSE_FILE:compose.basicauth.yml"
-#BASIC_AUTH=1
-#SECRET_USERSFILE_VERSION=v1
 
 #####################################################################
 # Prometheus metrics                                                #
@@ -82,15 +59,8 @@ COMPOSE_FILE="compose.yml"
 
 ## Enable prometheus metrics collection
 ## used used by the coop-cloud monitoring stack
-#COMPOSE_FILE="$COMPOSE_FILE:compose.metrics.yml"
 #METRICS_ENABLED=1
 
-#####################################################################
-# File provider directory configuration                             #
-# (Route bare metal and non-docker services on the machine!)        #
-#####################################################################
-#FILE_PROVIDER_DIRECTORY_ENABLED=1
-
 #####################################################################
 # Additional services                                               #
 #####################################################################
@@ -99,10 +69,6 @@ COMPOSE_FILE="compose.yml"
 #COMPOSE_FILE="$COMPOSE_FILE:compose.smtp.yml"
 #SMTP_ENABLED=1
 
-## Compy
-#COMPOSE_FILE="$COMPOSE_FILE:compose.compy.yml"
-#COMPY_ENABLED=1
-
 ## Gitea SSH
 # COMPOSE_FILE="$COMPOSE_FILE:compose.gitea.yml"
 # GITEA_SSH_ENABLED=1
@@ -126,12 +92,3 @@ COMPOSE_FILE="compose.yml"
 ## Mumble
 #COMPOSE_FILE="$COMPOSE_FILE:compose.mumble.yml"
 #MUMBLE_ENABLED=1
-
-## Matrix
-#COMPOSE_FILE="$COMPOSE_FILE:compose.matrix.yml"
-#MATRIX_FEDERATION_ENABLED=1
-
-## "Web alt", an alternative web port
-# NOTE(3wc): as of 2024-04-01 only the `icecast` recipe uses this
-#COMPOSE_FILE="$COMPOSE_FILE:compose.web-alt.yml"
-#WEB_ALT_ENABLED=1

README.md

@@ -7,11 +7,11 @@
 <!-- metadata -->
 * **Category**: Utilities
 * **Status**: ?
-* **Image**: [`traefik`](https://hub.docker.com/_/traefik), 4, upstream
+* **Image**: [`traefik`](https://hub.docker.com/_/traefik), ❶💚, upstream
 * **Healthcheck**: Yes
 * **Backups**: No
 * **Email**: N/A
-* **Tests**: 2
+* **Tests**: ❷💛
 * **SSO**: ? (Keycloak)
 <!-- endmetadata -->
 
@@ -19,29 +19,8 @@
 
 1. Set up Docker Swarm and [`abra`]
 2. `abra app new traefik`
-3. `abra app config YOURAPPDOMAIN` - be sure to change `DOMAIN` to something that resolves to
+3. `abra app YOURAPPDOMAIN config` - be sure to change `DOMAIN` to something that resolves to
    your Docker swarm box
-4. `abra app deploy YOURAPPDOMAIN`
+4. `abra app YOURAPPDOMAIN deploy`
-
-## Configuring wildcard SSL using DNS
-
-Automatic certificate generation will Just Work™ for most recipes  which use a fixed
-number of subdomains. For some recipes which need to work across arbitrary
-subdomains, like
-[`federatedwiki`](https://git.coopcloud.tech/coop-cloud/federatedwiki/) and
-[`go-ssb-room`](https://git.coopcloud.tech/coop-cloud/federatedwiki/), you'll
-need to give Traefik access to your DNS provider so that it can carry out
-Letsencrypt DNS challenges.
-
-1. Use Gandi or OVH for DNS 🤡 (support for other providers can be easily added,
-   see [the `lego` docs](https://go-acme.github.io/lego/dns/#dns-providers).
-2. Run `abra app config YOURAPPDOMAIN`
-3. Uncomment e.g. `ENABLE_GANDI` and the related `SECRET_.._VERSION` line, e.g.
-   `SECRET_GANDIV5_API_KEY_VERSION`
-4. Generate an API key for your provider
-5. Run `abra app secret insert YOURAPPDOMAIN SECRETNAME v1 SECRETVALUE`, where
-   `SECRETNAME` is from the compose file (e.g. `compose.gandi.yml`) e.g.
-   `gandiv5_api_key` and `SECRETVALUE` is the API key.
-6. Redeploy Traefik, using e.g. `abra app deploy YOURAPPDOMAIN -f`
 
 [`abra`]: https://git.autonomic.zone/autonomic-cooperative/abra

abra.sh

@@ -1,3 +1,3 @@
-export TRAEFIK_YML_VERSION=v20
+export TRAEFIK_YML_VERSION=v12
-export FILE_PROVIDER_YML_VERSION=v10
+export FILE_PROVIDER_YML_VERSION=v3
 export ENTRYPOINT_VERSION=v2

compose.basicauth.yml

@@ -1,12 +0,0 @@
-version: "3.8"
-services:
-  app:
-    environment:
-      - BASIC_AUTH
-    secrets:
-      - usersfile
-
-secrets:
-  usersfile:
-    name: ${STACK_NAME}_usersfile_${SECRET_USERSFILE_VERSION}
-    external: true

compose.compy.yml

@@ -1,7 +0,0 @@
-version: "3.8"
-services:
-  app:
-    environment:
-      - COMPY_ENABLED
-    ports:
-      - "9999:9999"

compose.errors.yml

@@ -1,29 +0,0 @@
----
-version: "3.8"
-
-services:
-  app:
-    environment:
-      - "CUSTOM_ERRORS=1"
-    volumes:
-      - "traefik-plugins:/plugins-local/"
-  errors:
-    image: "tarampampam/error-pages:2.27.0"
-    networks:
-      - proxy
-    deploy:
-      labels:
-          - "traefik.enable=true"
-          # use as "fallback" for any non-registered services (with priority below normal)
-          - "traefik.http.routers.${STACK_NAME}-error.rule=HostRegexp(`{host:.+}`)"
-          - "traefik.http.routers.${STACK_NAME}-error.priority=10"
-          - "traefik.http.routers.${STACK_NAME}-error.entrypoints=web-secure"
-          - "traefik.http.routers.${STACK_NAME}-error.tls.certresolver=${LETS_ENCRYPT_ENV}"
-          - "traefik.http.services.${STACK_NAME}-error.loadbalancer.server.port=8080"
-          # "errors" middleware settings
-          - "traefik.http.middlewares.${STACK_NAME}-error.errors.status=400-599"
-          - "traefik.http.middlewares.${STACK_NAME}-error.errors.service=${STACK_NAME}-error"
-          - "traefik.http.middlewares.${STACK_NAME}-error.errors.query=/{status}.html"
-
-volumes:
-  traefik-plugins:

compose.headless.yml

@@ -10,5 +10,6 @@ services:
       labels:
         - "traefik.enable=true"
         - "traefik.http.services.traefik.loadbalancer.server.port=web"
-        - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
+        - "traefik.http.routers.traefik.entrypoints=web-secure"
-        - "traefik.http.routers.${STACK_NAME}.service=api@internal"
+        - "traefik.http.routers.traefik.service=api@internal"
+        - "coop-cloud.${STACK_NAME}.app.version=v2.4.9-be23e1f6"

compose.keycloak.yml

@@ -5,9 +5,7 @@ services:
   app:
     deploy:
       labels:
-        - "traefik.http.routers.${STACK_NAME}.middlewares=keycloak@file"
+        - "traefik.http.routers.traefik.middlewares=keycloak@file"
     environment:
       - KEYCLOAK_MIDDLEWARE_ENABLED
       - KEYCLOAK_TFA_SERVICE
-      - KEYCLOAK_MIDDLEWARE_2_ENABLED
-      - KEYCLOAK_TFA_SERVICE_2

compose.matrix.yml

@@ -1,7 +0,0 @@
-version: "3.8"
-services:
-  app:
-    environment:
-      - MATRIX_FEDERATION_ENABLED
-    ports:
-      - "8448:8448"

compose.metrics.yml

@@ -1,9 +0,0 @@
-version: "3.8"
-services:
-  app:
-    environment:
-      - METRICS_ENABLED
-    ports:
-      - target: 8082
-        published: 8082
-        mode: host

compose.minio.yml

@@ -1,9 +0,0 @@
----
-version: "3.8"
-
-services:
-  app:
-    environment:
-      - MINIO_CONSOLE_ENABLED
-    ports:
-      - "9001:9001"

compose.web-alt.yml

@@ -1,7 +0,0 @@
-version: "3.8"
-services:
-  app:
-    environment:
-      - WEB_ALT_ENABLED
-    ports:
-      - "8000:8000"

compose.wildcard.yml

@@ -1,16 +0,0 @@
----
-version: "3.8"
-
-services:
-  app:
-    secrets:
-      - ssl_cert
-      - ssl_key
-
-secrets:
-  ssl_cert:
-    name: ${STACK_NAME}_ssl_cert_${SECRET_WILDCARD_CERT_VERSION}
-    external: true
-  ssl_key:
-    name: ${STACK_NAME}_ssl_key_${SECRET_WILDCARD_KEY_VERSION}
-    external: true

compose.yml

@@ -3,7 +3,7 @@ version: "3.8"
 
 services:
   app:
-    image: "traefik:v2.11.0"
+    image: "traefik:v2.5.2"
     # 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
@@ -13,7 +13,6 @@ services:
     volumes:
       - "/var/run/docker.sock:/var/run/docker.sock"
       - "letsencrypt:/etc/letsencrypt"
-      - "file-providers:/etc/traefik/file-providers"
     configs:
       - source: traefik_yml
         target: /etc/traefik/traefik.yml
@@ -41,14 +40,31 @@ services:
         order: start-first
       labels:
         - "traefik.enable=true"
-        - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=web"
+        - "traefik.http.services.traefik.loadbalancer.server.port=web"
-        - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
+        - "traefik.http.routers.traefik.rule=Host(`${DOMAIN}`)"
-        - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
+        - "traefik.http.routers.traefik.entrypoints=web-secure"
-        - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
+        - "traefik.http.routers.traefik.tls.certresolver=${LETS_ENCRYPT_ENV}"
-        - "traefik.http.routers.${STACK_NAME}.service=api@internal"
+        - "traefik.http.routers.traefik.tls.options=default@file"
-        - "traefik.http.routers.${STACK_NAME}.middlewares=security@file"
+        - "traefik.http.routers.traefik.service=api@internal"
-        - "coop-cloud.${STACK_NAME}.version=2.6.0+v2.11.0"
+        - "traefik.http.routers.traefik.middlewares=security@file"
-        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
+        - "coop-cloud.${STACK_NAME}.version=1.0.0+v2.5.2"
+
+  web:
+    image: tarampampam/error-pages:2.2.0
+    environment:
+      - TEMPLATE_NAME=shuffle
+    networks:
+      - proxy
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.services.error-pages-service.loadbalancer.server.port=8080"
+      - "traefik.http.routers.error-router.entrypoints=web-secure"
+      - "traefik.http.routers.error-router.rule=HostRegexp(`{host:.+}`)"
+      - "traefik.http.routers.error-router.priority=10"
+      - "traefik.http.routers.error-router.middlewares=error-pages-middleware@docker"
+      - "traefik.http.middlewares.error-pages-middleware.errors.status=400-599"
+      - "traefik.http.middlewares.error-pages-middleware.errors.service=error-pages-service@docker"
+      - "traefik.http.middlewares.error-pages-middleware.errors.query=/{status}.html"
 
 networks:
   proxy:
@@ -70,4 +86,3 @@ configs:
 
 volumes:
   letsencrypt:
-  file-providers:

file-provider.yml.tmpl

@@ -1,19 +1,6 @@
 ---
-
 http:
   middlewares:
-    {{ if eq (env "CUSTOM_ERRORS") "1" }}
-    error:
-      plugin:
-        traefik-error-page:
-          debug: "true"
-          contentsOnly: "false"
-          contentsOnlyMatch: "Bad Gateway"
-          query: /{status}.html
-          service: http://{{ env "STACK_NAME" }}_errors:8080
-          status:
-            - 502
-    {{ end }}
     {{ if eq (env "KEYCLOAK_MIDDLEWARE_ENABLED") "1" }}
     keycloak:
       forwardAuth:
@@ -22,22 +9,10 @@ http:
         authResponseHeaders:
           - X-Forwarded-User
     {{ end }}
-    {{ if eq (env "KEYCLOAK_MIDDLEWARE_2_ENABLED") "1" }}
-    keycloak2:
-      forwardAuth:
-        address: "http://{{ env "KEYCLOAK_TFA_SERVICE_2" }}:4181"
-        trustForwardHeader: true
-        authResponseHeaders:
-          - X-Forwarded-User
-    {{ end }}
-    {{ if eq (env "BASIC_AUTH") "1" }}
-    basicauth:
-      basicAuth:
-        usersFile: "/run/secrets/usersfile"
-    {{ end }}
     security:
       headers:
         frameDeny: true
+        sslRedirect: true
         browserXssFilter: true
         contentTypeNosniff: true
         stsIncludeSubdomains: true
@@ -57,8 +32,3 @@ tls:
         - CurveP521
         - CurveP384
       sniStrict: true
-  {{ if eq (env "WILDCARDS_ENABLED") "1" }}
-  certificates:
-    - certFile: /run/secrets/ssl_cert
-      keyFile: /run/secrets/ssl_key
-  {{ end }}

traefik.yml.tmpl

@@ -8,14 +8,8 @@ providers:
     exposedByDefault: false
     network: proxy
     swarmMode: true
-  {{ if eq (env "FILE_PROVIDER_DIRECTORY_ENABLED") "1" }}
-  file:
-    directory: /etc/traefik/file-providers
-    watch: true
-  {{ else }}
   file:
     filename: /etc/traefik/file-provider.yml
-  {{ end }}
 
 api:
   dashboard: {{ env "DASHBOARD_ENABLED" }}
@@ -24,6 +18,10 @@ api:
 entrypoints:
   web:
     address: ":80"
+    http:
+      redirections:
+        entryPoint:
+          to: web-secure
   web-secure:
     address: ":443"
   {{ if eq (env "GITEA_SSH_ENABLED") "1" }}
@@ -42,10 +40,6 @@ entrypoints:
   peertube-rtmp:
     address: ":1935"
   {{ end }}
-  {{ if eq (env "WEB_ALT_ENABLED") "1" }}
-  web-alt:
-    address: ":8000"
-  {{ end }}
   {{ if eq (env "SSB_MUXRPC_ENABLED") "1" }}
   ssb-muxrpc:
     address: ":8008"
@@ -60,20 +54,9 @@ entrypoints:
   mumble-udp:
     address: ":64738/udp"
   {{ end }}
-  {{ if eq (env "COMPY_ENABLED") "1" }}
-  compy:
-    address: ":9999"
-  {{ end }}
   {{ if eq (env "METRICS_ENABLED") "1" }}
   metrics:
     address: ":8082"
-    http:
-      middlewares:
-        - basicauth@file
-  {{ end }}
-  {{ if eq (env "MATRIX_FEDERATION_ENABLED") "1" }}
-  matrix-federation:
-    address: ":9001"
   {{ end }}
 
 ping:
@@ -83,8 +66,6 @@ ping:
 metrics:
   prometheus:
     entryPoint: metrics
-    addRoutersLabels: true
-    addServicesLabels: true
 {{ end }}
 
 certificatesResolvers:
@@ -113,12 +94,5 @@ certificatesResolvers:
         provider: {{ (env "LETS_ENCRYPT_DNS_CHALLENGE_PROVIDER") }}
         resolvers:
           - "1.1.1.1:53"
-          - "9.9.9.9:53"
+          - "8.8.8.8:53"
-      {{ end }}
-
-{{ if eq (env "CUSTOM_ERRORS") "1" }}
-experimental:
-  localplugins:
-    traefik-error-page:
-      moduleName: "github.com/3-w-c/traefik-error-page"
       {{ end }}