Ver Fonte

docs(oidc): document issuer URL policy and name-collision adoption

.env.example described what the required vars do but not two sharp
edges: the issuer must be a public HTTPS URL (an in-cluster
http://keycloak:8080 is silently refused), and BAMBUDDY_OIDC_NAME
matches an existing UI-created provider by name and takes it over.
Marian há 1 mês atrás
pai
commit
f6e0d76731
1 ficheiros alterados com 10 adições e 0 exclusões
  1. 10 0
      .env.example

+ 10 - 0
.env.example

@@ -116,3 +116,13 @@ LOG_TO_FILE=true
 # REQUIRE_EMAIL_VERIFIED=true, because an identity provider that does not
 # verify addresses would let anyone claim someone else's account. The whole
 # config is then skipped and logged; the app still starts.
+#
+# ISSUER_URL must be https:// and publicly reachable -- private, loopback,
+# link-local, numeric-encoded and IPv4-mapped hosts are rejected. An in-cluster
+# URL like http://keycloak:8080 is refused with a single log line and no SSO
+# button; use the externally-reachable HTTPS issuer URL instead.
+#
+# NAME is matched against the existing providers on every boot: setting it to
+# the name of one you already created in the UI ADOPTS and OVERWRITES it (its
+# issuer, client id and secret are replaced and it becomes read-only). Pick a
+# name that doesn't collide unless that takeover is intended.