kelin/arcane-registry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
kelinfoxy
2026-03-17 20:02:26 -04:00
parent f32a343cf3
commit 5d766f20e7
18 changed files with 132 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
README.md
View File

@@ -1,18 +1,127 @@
# Kelin's Arcane Registry # Authelia DuckDNS & Traefik based Arcane Registry
> Most templates configured with Traefik labels and Authelia middleware ## Approach
with subdomains at kelinreij.duckdns.org
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 ## Docker Compose Templates
* Backrest
* Bookstack
* Calibre-web
* Core * Core
* Authelia * Authelia
* DuckDNS (no webui) * DuckDNS (no webui)
* Traefik * Traefik
* Backrest
* Bookstack
* Calibre-web
* Docker-proxy (no webui) * Docker-proxy (no webui)
* Dokuwiki * Dokuwiki
* Dozzle * Dozzle

2
docker-templates/backrest/docker-compose.yml
View File

@@ -27,7 +27,7 @@ services:
retries: 3 retries: 3
start_period: 30s start_period: 30s
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/backrest.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/bookstack/docker-compose.yml
View File

@@ -29,7 +29,7 @@ services:
depends_on: depends_on:
- bookstack-db - bookstack-db
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/bookstack.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

0
docker-templates/calibre/.env → docker-templates/calibre-web/.env
View File

2
docker-templates/calibre/docker-compose.yml → docker-templates/calibre-web/docker-compose.yml
View File

@@ -19,7 +19,7 @@ services:
- DOCKER_MODS=linuxserver/mods:universal-calibre - DOCKER_MODS=linuxserver/mods:universal-calibre
# TRAEFIK CONFIGURATION # TRAEFIK CONFIGURATION
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/calibre-web.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/dbGate/compose.yaml
View File

@@ -15,7 +15,7 @@ services:
# environment: # environment:
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/dbgate.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/dokuwiki/docker-compose.yml
View File

@@ -15,7 +15,7 @@ services:
- PGID=${PGID} - PGID=${PGID}
- TZ=${TZ} - TZ=${TZ}
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/dokuwiki.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/dozzle/docker-compose.yml
View File

@@ -22,7 +22,7 @@ services:
retries: 3 retries: 3
start_period: 30s start_period: 30s
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/dozzle.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

4
docker-templates/gitea/docker-compose.yml
View File

@@ -29,7 +29,7 @@ services:
depends_on: depends_on:
- gitea-db - gitea-db
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/gitea.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}
@@ -55,7 +55,7 @@ services:
- POSTGRES_PASSWORD=${GITEA_DB_PASSWORD} - POSTGRES_PASSWORD=${GITEA_DB_PASSWORD}
- POSTGRES_DB=gitea - POSTGRES_DB=gitea
labels: labels:
- ${DB_ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/postgresql.svg
- 'homelab.category=productivity' - 'homelab.category=productivity'
- 'homelab.description=Gitea database' - 'homelab.description=Gitea database'

2
docker-templates/glances/docker-compose.yml
View File

@@ -15,7 +15,7 @@ services:
environment: environment:
- GLANCES_OPT=-w - GLANCES_OPT=-w
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/glances.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/homarr/docker-compose.yml
View File

@@ -19,7 +19,7 @@ services:
- DOCKER_PORTS=2375 - DOCKER_PORTS=2375
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/homarr.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/homepage/docker-compose.yml
View File

@@ -17,7 +17,7 @@ services:
- TZ=${TZ} - TZ=${TZ}
- HOMEPAGE_ALLOWED_HOSTS=${HOMEPAGE_ALLOWED_HOSTS}, ${SERVER_IP}:${EXTERNAL_PORT} - HOMEPAGE_ALLOWED_HOSTS=${HOMEPAGE_ALLOWED_HOSTS}, ${SERVER_IP}:${EXTERNAL_PORT}
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/homepage.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/jupyter/docker-compose.yml
View File

@@ -24,7 +24,7 @@ services:
# - NVIDIA_VISIBLE_DEVICES=all # - NVIDIA_VISIBLE_DEVICES=all
# - NVIDIA_DRIVER_CAPABILITIES=compute,utility # - NVIDIA_DRIVER_CAPABILITIES=compute,utility
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/jupyter.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/mealie/docker-compose.yml
View File

@@ -17,7 +17,7 @@ services:
- BASE_URL=https://${PROXY_URL} - BASE_URL=https://${PROXY_URL}
- DB_ENGINE=sqlite - DB_ENGINE=sqlite
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/mealie.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/metube/compose.yaml
View File

@@ -11,7 +11,7 @@ services:
volumes: volumes:
- ./downloads:/downloads - ./downloads:/downloads
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/metube.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/sablier/docker-compose.yml
View File

@@ -12,7 +12,7 @@ services:
- start - start
- --provider.name=docker - --provider.name=docker
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/sablier.svg
networks: networks:
traefik-network: traefik-network:

2
docker-templates/valutwarden/docker-compose.yml
View File

@@ -29,7 +29,7 @@ services:
retries: 3 retries: 3
start_period: 30s start_period: 30s
labels: labels:
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/vaultwarden-light.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}

2
docker-templates/yarnl/compose.yaml
View File

@@ -50,7 +50,7 @@ services:
condition: service_healthy condition: service_healthy
labels: labels:
- 'com.getarcaneapp.arcane.depends-on: yarnl-db' - 'com.getarcaneapp.arcane.depends-on: yarnl-db'
- ${ICON_LABEL} - com.getarcaneapp.arcane.icon=https://cdn.jsdelivr.net/gh/selfhst/icons@main/svg/yarnl.svg
- ${HOST_LABEL} - ${HOST_LABEL}
- ${LOADBALANCER_LABEL} - ${LOADBALANCER_LABEL}
- ${WATCHTOWER_ENABLE_LABEL} - ${WATCHTOWER_ENABLE_LABEL}