revert to using icon labels instead of hardcoding icons in the compose files.

2026-03-17 20:02:26 -04:00
parent f32a343cf3
commit 5d766f20e7
18 changed files with 132 additions and 23 deletions
--- a/README.md
+++ b/README.md
@@ -1,18 +1,127 @@
-# Kelin's Arcane Registry
+# Authelia DuckDNS & Traefik based Arcane Registry

-> Most templates configured with Traefik labels and Authelia middleware  
-with subdomains at kelinreij.duckdns.org
+## Approach

+Use env variables to template the required labels
+
+## Compose file template
+
+```bash
+services:
+  SERVICE_NAME:
+    image: 
+    container_name: 
+    restart: unless-stopped
+    networks:
+      - homelab-network
+      - traefik-network
+    ports:
+      - ${EXTERNAL_PORT}:${INTERNAL_PORT}
+    volumes:
+      - ./data:/data
+      - ./config:/config
+    environment:
+      - TZ=${TZ}
+      - PUID=${PUID}
+      - PGID=${PGID}
+    healthcheck:
+      test: ['CMD', 'wget', '--quiet', '--tries=1', '--spider', 'http://localhost:9898/']
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 30s
+    labels:
+      - com.getarcaneapp.arcane.icon=${ICON_URL}
+      - ${HOST_LABEL}
+      - ${LOADBALANCER_LABEL}
+      - ${WATCHTOWER_ENABLE_LABEL}
+      - ${TRAEFIK_ENABLE_LABEL}
+      - ${TRAEFIK_NETWORK_LABEL}
+      - ${ENTRYPOINT_LABEL}
+      - ${CERT_LABEL}
+      - ${AUTHELIA_LABEL}
+ 
+networks:
+  homelab-network:
+    external: true
+  traefik-network:
+    external: true
+
+x-dockge:
+  urls:
+    - https://${PROXY_URL}
+    - ${LOCAL_URL}
+
+x-arcane:
+  icon: ${ICON_URL}
+  urls:
+    - https://${PROXY_URL}
+    - ${LOCAL_URL}
+
+```
+
+## .env template
+
+```bash
+# #######################################################
+# Templating variables, not used by compose file directly
+SERVER_NAME=
+SERVER_IP=
+SUBDOMAIN=
+SERVICE_NAME=
+ICON_URL=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/${SERVICE_NAME}.svg
+
+# Include Server Name in Proxy URL? Choose one.
+
+# PROXY_URL=${SERVICE_NAME}.${SERVER_NAME}.${SUBDOMAIN}.duckdns.org
+PROXY_URL=${SERVICE_NAME}.${SUBDOMAIN}.duckdns.org
+
+
+# #############################################################################
+# Compose file variables
+
+TZ=America/New_York
+PUID=1000
+PGID=1000
+
+CONTAINER_NAME=${SERVICE_NAME}
+INTERNAL_PORT=8081
+EXTERNAL_PORT=8099
+LOCAL_URL=http://${SERVER_IP}:${EXTERNAL_PORT}
+
+
+# #############################################################
+# Container Labels
+
+# DO NOT enclose label values in single quotes
+# If the value needs to include single quotes use backticks instead
+
+# For example HOST_LABEL=traefik.http.routers.${SERVICE_NAME}.rule=Host(`${PROXY_URL}`)
+# Notice the use of backticks instead of single quotes around ${PROXY_URL}
+
+TRAEFIK_ENABLE_LABEL=traefik.enable=true
+HOST_LABEL=traefik.http.routers.${SERVICE_NAME}.rule=Host(`${PROXY_URL}`)
+ICON_LABEL=com.getarcaneapp.arcane.icon=${ICON_URL}
+LOADBALANCER_LABEL=traefik.http.services.${SERVICE_NAME}.loadbalancer.server.port=${INTERNAL_PORT}
+
+TRAEFIK_NETWORK_LABEL=traefik.docker.network=traefik-network
+ENTRYPOINT_LABEL=traefik.http.routers.${SERVICE_NAME}.entrypoints=websecure
+CERT_LABEL=traefik.http.routers.${SERVICE_NAME}.tls.certresolver=letsencrypt
+
+AUTHELIA_LABEL=traefik.http.routers.${SERVICE_NAME}.middlewares=authelia@docker
+WATCHTOWER_ENABLE_LABEL=com.centurylinklabs.watchtower.enable=true
+```

 ## Docker Compose Templates

-* Backrest
-* Bookstack
-* Calibre-web
 * Core
  * Authelia
  * DuckDNS  (no webui)
  * Traefik
+
+* Backrest
+* Bookstack
+* Calibre-web
 * Docker-proxy  (no webui)
 * Dokuwiki
 * Dozzle