Part A — lossless upgrades: - Persist both bundled Redis stores via AOF+RDB on named volumes (sso-data, proxy-data) so OAuth clients, Host records, perms, DNS creds, and auto-ssl Let's Encrypt certs survive rebuilds. - setup.sh: backup_before_rebuild() snapshots ./config/ + LDAP (slapcat) + both Redis (BGSAVE + compose cp) to ./backups/<ts>/ before each rebuild, keeps last BACKUP_KEEP (default 5). First run is a no-op. - Restore runbook (README + docs): full / Redis-only / LDAP-only, with the AOF-vs-RDB note (delete the AOF before restoring an RDB). Part B — eliminate .env / proxy.env: - All config + secrets live in bind-mounted ./config/ (gitignored), read by each app's @simpleworkjs/conf from a symlinked secrets.js. Compose passes only NODE_ENV + NODE_PORT (no app_* env, which would override secrets.js). - ./config/sso-secrets.js: app secrets + orchestrator-only stack/bootstrap/ serviceAccountPass keys (app ignores the ones it doesn't use). - ./config/proxy-secrets.js: oidc (clientId/clientSecret filled in by the bootstrap), ldap (bind creds), auth (admin groups/users). - setup.sh ensure_config(): generates ./config/ with random secrets on first run (then exits for editing); one-time migration from .env/proxy.env preserving existing secrets (LDAP admin pass, JWT, OAuth client, service pass) so a running deployment keeps its directory + tokens + OAuth client. - bootstrap/bootstrap.js: reads /config/*.js (not process.env), registers the proxy as an OIDC client, and writes the SSO-generated client id+secret back into ./config/proxy-secrets.js (sso mounts ./config RW, proxy RO). - config.example/ holds committed annotated templates for manual reference. - .gitignore: add config/, backups/, *.rdb, *.ldif. Bump both gitlinks to the merged submodule tips: - sso-manager-node -> 6920a9f (PR #34) - proxy -> 8e78604 (PR #118) Co-authored-by: Claude <noreply@anthropic.com>
3.5 KiB
layout, title
| layout | title |
|---|---|
| default | Standalone |
Running each project standalone
theta-env composes the two projects but doesn't fork them — both work on their own. The submodules in this repo are normal clones; you can also clone them directly from GitHub.
SSO Manager alone
The all-in-one image (Dockerfile.openldap) bundles the app + OpenLDAP + Redis:
git clone https://github.com/theta42/sso-manager-node.git
cd sso-manager-node
mkdir -p config && cp secrets.js.example config/sso-secrets.js # edit it
docker compose up -d --build
The entrypoint symlinks config/sso-secrets.js to nodejs/conf/secrets.js so
@simpleworkjs/conf reads it. Set ldap.bindPassword, oauth.jwtSecret, and
the stack/bootstrap keys (the app ignores the ones it doesn't use). Pass
no app_* env — env beats secrets.js, so app_* would silently override
your file.
- Web UI:
http://localhost:3001 - Health:
http://localhost:3001/health - OIDC discovery:
http://localhost:3001/.well-known/openid-configuration - LDAPS:
ldaps://<host>:636
Requires @simpleworkjs/conf >= 1.1.0. Full reference:
SSO Manager deployment docs.
Bare metal
sudo ./install.sh -p 'your-ldap-password' -b 'dc=yourdomain,dc=com' -n 'Your Org' -o 3001
sudo systemctl enable --now sso-manager
Idempotent — re-run to update. See the SSO Manager deployment guide.
Proxy alone
The all-in-one image (Dockerfile) bundles OpenResty + the Node app + Redis:
git clone https://github.com/theta42/proxy.git
cd proxy
mkdir -p config && cp secrets.js.example config/proxy-secrets.js # edit it
docker compose up -d --build
The entrypoint symlinks config/proxy-secrets.js to nodejs/conf/secrets.js so
@simpleworkjs/conf reads it. Fill in oidc (your SSO's endpoints +
clientId/clientSecret/redirectUri), ldap (bind creds + search base), and
auth (admin groups/users). Pass no app_* env — env beats secrets.js,
so app_* would silently override your file.
- Proxy (public, auto-SSL):
https://<host>/ - Mgmt UI / API:
http://127.0.0.1:3000/ - Health:
http://127.0.0.1:3000/health
Requires @simpleworkjs/conf >= 1.1.0. Full reference:
proxy deployment docs.
Bare metal
wget -O - https://raw.githubusercontent.com/theta42/proxy/master/ops/install.sh | sudo bash
See the proxy Docker guide / installation guide.
Mixing and matching
theta-env isn't required to use the two together — the four wiring steps are documented in both projects' deployment guides:
- One Docker network (or reachable hostnames) so the proxy can reach the SSO internally for token/userinfo + LDAPS.
- Set the SSO's
oauth.issuer(in itssecrets.js) to the browser-facing HTTPS URL the proxy serves the SSO at. - Register the proxy as an OIDC client in the SSO, with
redirectUrimatching the proxy's callback; put the resultingclientId/clientSecretin the proxy'ssecrets.js. - Point the proxy's
ldap.urlat the SSO's LDAPS + create a dedicatedcn=ldapclientservice account; set the same password asbindPassword.
theta-env just automates those four steps with ./setup.sh. If you prefer to
do them by hand (or want the two on separate hosts), follow the standalone
guides above.