Files
Homelab-manager/.env.example
T
bobbanandClaude Sonnet 5.5 7e196be56d Let an installation look different via ENVIRONMENT_NAME and ENVIRONMENT_COLOR
Setting ENVIRONMENT_NAME (and optionally ENVIRONMENT_COLOR, a name or hex
value) gives the sidebar that colour, adds a name badge next to the title and
on the sign-in page, and prefixes the browser tab title, so a dev copy can't
be taken for production. Unset, nothing changes. The colour is validated to a
plain #rrggbb before it reaches the page's styles. A public
GET /api/environment lets the sign-in page use it too.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-13 20:59:25 +02:00

43 lines
2.2 KiB
Bash

# Public URL the app is reachable at (used for OIDC redirect_uri and cookie behavior).
APP_BASE_URL=https://homelab.example.lan
# Optional: make this installation look different, so a dev copy can't be taken for production.
# The sidebar takes the colour, a badge with the name is shown next to the title (and on the sign-in page),
# and the browser tab reads "[Dev] Homelab Manager". Leave both out for the normal look.
# ENVIRONMENT_COLOR is a name (red, orange, amber, green, teal, blue, purple, pink, gray) or a hex value like #b45309.
# A name without a colour gets orange.
# ENVIRONMENT_NAME=Dev
# ENVIRONMENT_COLOR=orange
# Random long string used to sign session cookies. Generate with:
# node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
# Required in production: without it the app refuses to start (the alternative is a value that is
# in the source code). Changing it signs everyone out.
SESSION_SECRET=change-me-to-a-random-64-char-hex-string
# 32-byte (64 hex char) key used to encrypt stored integration API tokens, and the
# notification channels' credentials (Gotify/ntfy tokens, SMTP password, webhook
# secret), at rest (AES-256-GCM). Generate the same way as SESSION_SECRET.
# Losing/changing this key makes those stored credentials unreadable.
CREDENTIALS_ENCRYPTION_KEY=change-me-to-a-random-64-char-hex-string
# Port docker-compose publishes on the host (container always listens on 3000).
HOST_PORT=3000
# Optional, for the arm64 compose files (docker-compose.arm64*.yml): registry image and tag.
#IMAGE_REPO=gitea.labsconnect.se/bobban/homelabmanager-homelab-manager
#ARM64_TAG=arm64
# --- Authentik OIDC application/provider ---
# Create an OAuth2/OIDC "Provider" in Authentik with:
# Redirect URI: <APP_BASE_URL>/auth/callback
# Scopes: openid, email, profile
# then create an "Application" using that provider, and assign the users/groups
# who should be able to sign in. Copy the provider's values below.
AUTHENTIK_ISSUER_URL=https://authentik.example.lan/application/o/homelab-manager/
AUTHENTIK_CLIENT_ID=
AUTHENTIK_CLIENT_SECRET=
# Notification channels (Gotify, ntfy, SMTP, webhook) are configured in-app
# under Settings, not here.