diff --git a/README.md b/README.md index c23168f..0202acb 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,16 @@ Each project still runs **standalone** (`docker compose up` in its own folder); this repo just composes them and automates the first-run glue so they find each other. +**Documentation:** [https://theta42.github.io/theta-env/](https://theta42.github.io/theta-env/) + +## Screenshots + +The SSO Manager and the proxy it fronts, both stood up by one `./setup.sh` run: + +| SSO Manager Dashboard | Proxy Hosts | +| --- | --- | +| ![SSO Manager dashboard](docs/images/sso-dashboard.png) | ![Proxy host list](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 diff --git a/docs/images/proxy-hosts.png b/docs/images/proxy-hosts.png new file mode 100644 index 0000000..24b9257 Binary files /dev/null and b/docs/images/proxy-hosts.png differ diff --git a/docs/images/sso-dashboard.png b/docs/images/sso-dashboard.png new file mode 100644 index 0000000..6886d8f Binary files /dev/null and b/docs/images/sso-dashboard.png differ diff --git a/docs/index.md b/docs/index.md index dadd05d..ffc5986 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,6 +14,14 @@ It exists for people whose needs are met by these two projects and who want to run them "very simply." Each project still works **standalone**; this repo just wires them together and automates the first-run glue. +## Screenshots + +The SSO Manager and the proxy it fronts, both stood up by one `./setup.sh` run: + +| SSO Manager Dashboard | Proxy Hosts | +| --- | --- | +| ![SSO Manager dashboard](images/sso-dashboard.png) | ![Proxy host list](images/proxy-hosts.png) | + --- ## Quick start @@ -21,7 +29,7 @@ wires them together and automates the first-run glue. ```bash git clone --recursive https://github.com/theta42/theta-env.git cd theta-env -cp setup.env.example setup.env # then edit setup.env: set CFG_BASE_DN to your domain +cp setup.env.example setup.env # then edit setup.env: set CFG_DOMAIN to your domain ./setup.sh # first run: generates ./config/ from setup.env, builds + bootstraps + starts ```