Files

151 lines
6.7 KiB
Bash

TYPE=hopps
DOMAIN=hopps.example.com
## Domain aliases
#EXTRA_DOMAINS=', `www.hopps.example.com`'
LETS_ENCRYPT_ENV=production
ENABLE_BACKUPS=true
COMPOSE_FILE="compose.yml"
# Copy to .env and fill in. Everything without a value below is required,
# unless its comment says optional or it belongs to a part you did not enable.
# `docker compose up -d` will refuse to work properly without them.
# ------------------------------------------------------- identity provider --
# Who manages the user accounts:
# keycloak Hopps's own Keycloak (default). Fill in block B below; the
# Keycloak overlay is already in COMPOSE_FILE.
# authentik An existing Authentik instance. Fill in block A below and
# remove docker-compose.keycloak.yaml from COMPOSE_FILE.
HOPPS_AUTH_PROVIDER=authentik
# ------------------------------------------------------------- public URLs --
# How the browser reaches each component. For a real deployment put a reverse
# proxy with TLS in front and use https:// hostnames here. No trailing slash.
PUBLIC_SPA_URL=https://$DOMAIN
PUBLIC_ORG_URL=https://org.$DOMAIN
# ------------------------------------------------------------- tenancy -----
# single: this installation serves exactly one association. The organization is
# created once during the initial setup in the browser; afterwards there
# is no sign-up, the SaaS-only admin API is off, and anyone who can log in
# but is not a member of the organization is told to ask for an invitation.
# multi: the hosted SaaS behaviour - anyone can register an organization.
# Switching an existing installation from multi to single refuses to start while
# the database holds more than one organization.
HOPPS_TENANCY_MODE=single
# ------------------------------------------------------------ branding -----
VITE_TITLE=Hopps
VITE_GENERAL_DATE_FORMAT=dd.MM.yyyy
# ------------------------------------------- Impressum & Datenschutz --------
# You are responsible for the legal pages of your instance. Two ways to provide
# them (a URL wins over a mounted file; leave both empty to hide the page):
# 1. Link an existing page:
# HOPPS_IMPRINT_URL=https://example.org/impressum
# HOPPS_PRIVACY_URL=https://example.org/datenschutz
# 2. Mount your own content: enable the `./legal:/app/legal:ro` volume in
# docker-compose.yaml and drop impressum.html / datenschutz.html in ./legal.
# See legal/README.md for details and templates.
HOPPS_IMPRINT_URL=
HOPPS_PRIVACY_URL=
# ============================================================================
# A) Authentik (HOPPS_AUTH_PROVIDER=authentik)
# ============================================================================
# Required with HOPPS_AUTH_PROVIDER=authentik, ignored otherwise.
# People log in with their Authentik account. Registering an organization
# creates the founder's account there, and inviting someone links their
# existing account or creates one.
# Setup in Authentik: README.md, "Identity provider".
# Uncomment to enable Authentik authentication
COMPOSE_FILE="$COMPOSE_FILE:compose.authentik.yml"
# Issuer of the Hopps application in Authentik, exactly as its
# /.well-known/openid-configuration reports it, trailing slash included, e.g.
# https://auth.example.org/application/o/hopps/
# Opened by the browser, so it must be publicly reachable.
PUBLIC_OIDC_ISSUER_URL=https://auth.example.com/application/o/hopps/
# Client ID of the OAuth2/OpenID provider behind that application.
OIDC_CLIENT_ID=hopps
# Base URL of Authentik, no trailing slash, e.g. https://auth.example.org
# Authentik builds the set-password links from it, so use the address invited
# people can open.
AUTHENTIK_URL=https://auth.example.com
# Token of a service account allowed to view, create and delete users
# (Directory -> Tokens and App passwords, intent "API").
#AUTHENTIK_API_TOKEN=
# Optional. UUID of an Authentik "Email" stage that mails invited people their
# set-password link. Left empty, the inviting admin gets the link to pass on.
#AUTHENTIK_EMAIL_STAGE_ID=
# Authentik secret
SECRET_AUTHENTIK_CLIENT_SECRET_VERSION=v1
SECRET_DB_PASSWORD_VERSION=v1
# ============================================================================
# B) Keycloak (HOPPS_AUTH_PROVIDER=keycloak)
# ============================================================================
# Required with HOPPS_AUTH_PROVIDER=keycloak (the default), together with
# docker-compose.keycloak.yaml in COMPOSE_FILE. Ignored otherwise.
#PUBLIC_KEYCLOAK_URL=http://localhost:8092
#KEYCLOAK_PORT=8092
# Bound to 127.0.0.1 only. Web UI of the mail catcher Keycloak sends through.
#MAILPIT_UI_PORT=8025
#KEYCLOAK_ADMIN=admin
#KEYCLOAK_ADMIN_PASSWORD=
# Uncomment and set to "xforwarded" when Keycloak sits behind a reverse proxy that
# terminates TLS. Leave it out entirely otherwise - an empty value is rejected.
#KC_PROXY_HEADERS=xforwarded
# --------------------------------- Keycloak: brokering to another provider --
# Optional: let people sign in at Keycloak with an existing OpenID Connect
# provider (Authentik, Entra ID, Google Workspace, another Keycloak, ...) in
# addition to a password managed there. Accounts are still created in Keycloak.
# Leave IDP_ENABLED=false to keep Keycloak logins only.
#
# Applied on the FIRST start only, together with the rest of the realm. To add a
# provider to a running installation, use the Keycloak admin console instead
# (Identity providers -> OpenID Connect v1.0).
#
# Whitelist this redirect URI at the provider:
# <PUBLIC_KEYCLOAK_URL>/realms/quarkus/broker/<IDP_ALIAS>/endpoint
#
# Setup walkthrough, including a local Authentik to test against: EXTERNAL-IDP.md
#IDP_ENABLED=false
# Internal name. Appears in the redirect URI above and selects the button logo
# in the login theme - see EXTERNAL-IDP.md, "Showing the provider's logo".
#IDP_ALIAS=oidc
# Button caption on the login page.
#IDP_DISPLAY_NAME=Single sign-on
#IDP_CLIENT_ID=
#IDP_CLIENT_SECRET=
# Endpoints, straight from the provider's /.well-known/openid-configuration.
# authorization_endpoint and end_session_endpoint are opened in the user's
# BROWSER; the others are called by Keycloak itself and may use an internal
# address. IDP_ISSUER must match the "iss" claim byte for byte, trailing slash
# included. https:// is required unless REALM_SSL_REQUIRED is relaxed.
#IDP_AUTHORIZATION_URL=
#IDP_TOKEN_URL=
#IDP_USERINFO_URL=
#IDP_JWKS_URL=
#IDP_LOGOUT_URL=
#IDP_ISSUER=
# LOCAL TESTING ONLY. Keycloak refuses plain-http identity provider URLs; setting
# this to "none" turns that check off so a local Authentik can be used without TLS.
# Never set this in a real deployment - it also disables Keycloak's own HTTPS
# requirement for the realm. See EXTERNAL-IDP.md, "Trying it locally with Authentik".
#REALM_SSL_REQUIRED=external