diff --git a/README.md b/README.md index a109f51..c239900 100644 --- a/README.md +++ b/README.md @@ -26,14 +26,18 @@ The SSO Manager and the proxy it fronts, both stood up by one `./setup.sh` run: | --- | --- | | [![SSO Manager dashboard](docs/images/sso-dashboard.png)](docs/images/sso-dashboard.png) | [![Proxy host list](docs/images/proxy-hosts.png)](docs/images/proxy-hosts.png) | -**Why use this instead of running the two separately?** The two only become -useful once the proxy is registered as an OIDC client of the SSO and pointed at -the SSO's LDAP directory — and the SSO's domain has to match across half a dozen -config fields or logins silently fail with `Invalid Credentials`. Doing that by -hand is fiddly and easy to get wrong. `setup.sh` asks for your domain once (in -`setup.env`), generates both config files with it filled in everywhere, registers -the proxy as an OIDC client, and snapshots state before every rebuild — so you -get a working SSO + proxy stack in one command and a safe way to upgrade it. +## Configuration + +`setup.sh` automates the first-run glue between subprojects: +- Asks for your domain once (in `setup.env`) and fills it in across all config files. +- Registers the proxy as an OIDC client of the SSO. +- Persists submodule commit hashes in `.env` for reproducibility (e.g., `SSO_GIT_COMMIT`, `PROXY_GIT_COMMIT`). This ensures future `docker compose` runs use the same submodule versions. + +**Why use this instead of running the two separately?** The two only become useful once the proxy is registered as an OIDC client of the SSO and pointed at the SSO's LDAP directory — and the SSO's domain has to match across half a dozen config fields or logins silently fail with `Invalid Credentials`. Doing that by hand is fiddly and easy to get wrong. `setup.sh` handles this automatically and snapshots state before every rebuild — so you get a working SSO + proxy stack in one command and a safe way to upgrade it. + +## Unified Release Status +- ✅ **Phase 1 (oidc-client)**: Complete. +- ⏳ **Phases 2-5**: Pending (see [roadmap](#)). ``` ┌──────────────────────────────────────────────┐ diff --git a/proxy b/proxy index fdf8c91..0e98cab 160000 --- a/proxy +++ b/proxy @@ -1 +1 @@ -Subproject commit fdf8c919da01ea5ad4b1ec415bfa9ad28e15d749 +Subproject commit 0e98cab3d3372a5fe054e05f2a5c6f5128db78ef diff --git a/sso-manager-node b/sso-manager-node index 86d6ff8..887b775 160000 --- a/sso-manager-node +++ b/sso-manager-node @@ -1 +1 @@ -Subproject commit 86d6ff8ef09bba8c3607bf5ac809e89ec7ba7fc0 +Subproject commit 887b775b4216a2cf7606c2536e1a157f31f9cbc5