diff --git a/.env.example b/.env.example index e6fde85..29d78db 100644 --- a/.env.example +++ b/.env.example @@ -1,39 +1,50 @@ -# Timezone -TZ=America/New_York -# Source directories -SOURCE_STACKS_DIR=/opt -SOURCE_HOME_DIR=/~ - -# Backup location directory -BACKUP_DIR=/mnt/restic-usb - -# Server Details SERVER_NAME= SERVER_IP= - -# Service Details -DOCKER_IMAGE= -CONTAINER_NAME= +SUBDOMAIN= SERVICE_NAME= -INTERNAL_PORT= -EXTERNAL_PORT= -LOCAL_URL=http://${SERVER_IP}.${EXTERNAL_PORT} -# Services that exist on multiple servers should include ${SERVER_NAME} +# Services that exist on multiple servers should include ${SERVER_NAME} in PROXY_URL # Services that exist on a single server can omit ${SERVER_NAME} PROXY_URL=${SERVICE_NAME}.${SERVER_NAME}.${SUBDOMAIN}.duckdns.org -CATEGORY_LABEL= -DESCRIPTION_LABEL= -HOST_LABEL='traefik.http.routers.${SERVICE_NAME}.rule=Host(`${PROXY_URL}`)' -LOADBALANCER_LABEL='traefik.http.services.${SERVICE_NAME}.loadbalancer.server.port=${INTERNAL_PORT}' +# ############################################################################# +# Variables above this line are used for templating only, +# they are not used by the compose file directly -# Enable Traefik label -TRAEFIK_ENABLE_LABEL='traefik.enable=true' -# Enable Authelia label -AUTHELIA_LABEL='traefik.http.routers.${SERVICE_NAME}.middlewares=authelia@docker' +# ############################################################################# +# Remaining Variables are used by the compose file -# Enable Watchtower label -WATCHTOWER_ENABLE_LABEL='com.centurylinklabs.watchtower.enable=true' \ No newline at end of file +CONTAINER_NAME=${SERVICE_NAME} +CONTAINER_IMAGE= +INTERNAL_PORT= +EXTERNAL_PORT= +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} + +WATCHTOWER_ENABLE_LABEL=com.centurylinklabs.watchtower.enable=true + +CATEGORY_LABEL=homelab.description= + +DESCRIPTION_LABEL=homelab.category= + +TRAEFIK_ENABLE_LABEL=traefik.enable=true + +TRAEFIK_NETWORK_LABEL=traefik.docker.network=traefik-network + +HOST_LABEL=traefik.http.routers.${SERVICE_NAME}.rule=Host(`${PROXY_URL}`) + +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 + +LOADBALANCER_LABEL=traefik.http.services.${SERVICE_NAME}.loadbalancer.server.port=${INTERNAL_PORT} \ No newline at end of file