wmantly
e46768bb68
- CHANGELOG.md now embeds full app-level release notes for submodule bumps. - .env.example uses explicit CHANGE-ME placeholders instead of realistic-looking defaults. - config.example comments describe the actual CONF_SECRETS mechanism. - setup.sh summary no longer prints generated passwords to stdout. - bootstrap.js fails hard instead of falling back to weak default passwords. Note: submodule pins will be updated to v1.1.16 after the app PRs merge. Co-Authored-By: Claude <noreply@anthropic.com>
79 lines
3.9 KiB
Bash
79 lines
3.9 KiB
Bash
# theta-env — unified SSO Manager + Proxy deployment.
|
|
#
|
|
# Copy this file to `.env` and fill in the values, then run `./setup.sh`.
|
|
# All values are read by setup.sh / docker-compose / the bootstrap.
|
|
#
|
|
# Values may contain spaces. Quote them if they could be split by a shell,
|
|
# e.g. ORG_NAME="My Org" or SMTP_FROM="Theta SSO <noreply@example.com>".
|
|
# Quotes are optional but harmless — setup.sh + docker compose strip a single
|
|
# matching pair of outer quotes from any value.
|
|
|
|
# ── Directory / domain (REQUIRED-ish — set these) ────────────────────────────
|
|
|
|
# Your organization's LDAP base DN. Derives the LDAP domain + cert defaults.
|
|
LDAP_BASE_DN=dc=example,dc=com
|
|
# DNS domain (dc=foo,dc=bar -> foo.bar). Leave blank to derive from LDAP_BASE_DN.
|
|
LDAP_DOMAIN=
|
|
# LDAP admin password. MUST be changed. Leave blank and setup.sh will generate one.
|
|
LDAP_ADMIN_PASS=CHANGE-ME
|
|
ORG_NAME="My Org"
|
|
|
|
# ── Public hostnames (REQUIRED) ───────────────────────────────────────────────
|
|
# The proxy serves the SSO Manager UI at https://<SSO_HOST> and its own
|
|
# management UI at https://<PROXY_HOST>. Both must resolve (DNS or hosts file)
|
|
# to the host running this stack, and the proxy must be able to complete ACME
|
|
# (port 80 reachable) for real certs — or use the self-signed fallback on LAN.
|
|
SSO_HOST=sso.example.com
|
|
PROXY_HOST=proxy.example.com
|
|
|
|
# ── First admin (created in the SSO by the bootstrap) ───────────────────────
|
|
# The bootstrap creates this user in LDAP, adds them to app_sso_admin +
|
|
# app_sso_oauth_admin, and logs in as them to register the proxy OAuth client.
|
|
# Re-running setup.sh resets this password to BOOTSTRAP_ADMIN_PASS.
|
|
BOOTSTRAP_ADMIN_UID=admin
|
|
# First admin password. MUST be changed. Leave blank and setup.sh will generate one.
|
|
BOOTSTRAP_ADMIN_PASS=CHANGE-ME
|
|
BOOTSTRAP_ADMIN_EMAIL=admin@example.com
|
|
|
|
# ── Proxy LDAP service account (created by the bootstrap) ────────────────────
|
|
# The proxy binds to LDAP as cn=ldapclient,ou=people,<base> with this password.
|
|
# Re-running setup.sh resets it to LDAP_SERVICE_PASS.
|
|
# LDAP service-account password. MUST be changed. Leave blank and setup.sh will generate one.
|
|
LDAP_SERVICE_PASS=CHANGE-ME
|
|
|
|
# ── OAuth JWT secret (REQUIRED — persist it) ────────────────────────────────
|
|
# Signs the SSO's access/refresh tokens. Generate with: openssl rand -hex 32
|
|
# Leave blank to auto-generate (NOT persisted across container recreation —
|
|
# set it explicitly for a stable install).
|
|
JWT_SECRET=
|
|
|
|
# ── Optional: outbound email (SSO password resets / invites) ─────────────────
|
|
SMTP_HOST=
|
|
SMTP_PORT=587
|
|
SMTP_USER=
|
|
SMTP_PASS=
|
|
SMTP_FROM=
|
|
|
|
# ── Optional: host port overrides ───────────────────────────────────────────
|
|
# SSO web UI + proxy mgmt UI host ports.
|
|
SSO_PORT=3001
|
|
LDAPS_PORT=636
|
|
# Proxy listeners:
|
|
HTTP_PORT=80
|
|
HTTPS_PORT=443
|
|
HTTPS_ALT_PORT=4443
|
|
MGMT_PORT=3000
|
|
|
|
# ── Optional: bind address for the SSO UI (3001) + proxy mgmt UI (3000) ───────
|
|
# Default 0.0.0.0 = reachable on the LAN (convenient for first-run / admin from
|
|
# another machine). These UIs are login-protected, but exposing them widens the
|
|
# attack surface; once the proxy fronts both under TLS you can lock them to the
|
|
# host only by setting each to 127.0.0.1.
|
|
SSO_BIND=0.0.0.0
|
|
MGMT_BIND=0.0.0.0
|
|
|
|
# ── Optional: LDAP TLS cert CN (hostname LDAPS clients verify) ───────────────
|
|
# Defaults to LDAP_DOMAIN. Set to the hostname the proxy connects via
|
|
# (sso-manager inside the docker net uses the service name, which is in the
|
|
# cert's SAN, so the default is usually fine).
|
|
LDAP_CERT_CN= |