From e8dfd1eada936fbaeb8cd0ca81629bae5d035983 Mon Sep 17 00:00:00 2001 From: Mart van Santen <mart@greenhost.nl> Date: Tue, 7 Dec 2021 14:48:42 +0100 Subject: [PATCH] Update documentation --- docs/helmchart.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/helmchart.md b/docs/helmchart.md index b2fd90f..2b08167 100644 --- a/docs/helmchart.md +++ b/docs/helmchart.md @@ -28,6 +28,8 @@ This table lists the variables you are most likely to change. Take a look at the | Parameter | Description | Default | | ------------------------------------ | ------------------------------------------------------- | ------------------------- | +| `singleSignOnHost` | **FQDN of the openID Connect / oAuth2 server** | **sso.stackspin.example.net** | +| `loginHost` | **FQDN of the login panel + kratos** | **sso.stackspin.example.net** | | `login.image.repository` | Name of image repository to be used for login provider | open.greenhost.net:4567/stackspin/single-sign-on/login | | `login.image.tag` | Release version of login provider image | main | | `login.login` | Username of user to create during installation | admin@example.com | @@ -36,7 +38,21 @@ This table lists the variables you are most likely to change. Take a look at the | `login.db.password` | Database password for backend | stackspin | | `login.db.database` | Database name for backend | stackspin | | `login.db.user` | Database user for backend | stackspin | -| `singleSignOnHost` | **FQDN of the openID Connect / oAuth2 server** | **sso.stackspin.example.net** | +| `kratos.kratos.identitySchemas` | Tupple of filenames and JSON data to install as available schema filee | See values.yaml | +| `kratos.kratos.config.identity.default_schema_url` | Location of default schem file | file:///etc/config/identity.default.schema.json | +| `kratos.kratos.config.dsn` | Database endpoint | postgres://kratos:kratos@single-sign-on-postgresql:5432/kratos | +| `kratos.kratos.serve.public.base_url` | URL where to find kratos public API | **https://sso.stackspin.example.net/api/** | +| `kratos.kratos.selfservice.default_browser_return_url` | Default URL to return to with unknown request | **https://sso.stackspin.example.net/login/login** | +| `kratos.kratos.selfservice.methods.link.enabled` | If account recovery with a recovery link is enabled | true | +| `kratos.kratos.selfservice.flows.recovery.enabled` | If account recovery flow is enabled | true | +| `kratos.kratos.selfservice.flows.recovery.lifespan` | Time recovery link is valid for password reset | 15m | +| `kratos.kratos.selfservice.flows.recovery.ui_url` | Where to link to for recovery | **https://sso.stackspin.example.net/login/recovery** | +| `kratos.kratos.selfservice.flows.login.ui_url` | Where to link to for login | **https://sso.stackspin.example.net/login/login** | +| `kratos.kratos.selfservice.flows.settings.ui_url` | Where to link to for setting/profile update | **https://sso.stackspin.example.net/login/settings** | +| `kratos.kratos.selfservice.flows.registration.ui_url` | Where to link to for account registration | **https://sso.stackspin.example.net/login/registration** | +| `kratos.kratos.secrets.sessions` | Arrey of strings for seesion secrets | See values.yaml | +| `kratos.kratos.courier.smtp.connection_url` | Config of SMTP server | smtps://username:password@smtp.example.net:456/ | +| `kratos.kratos.courier.smtp.from_address` | From email address | no-reply@example.net | | `hydra.hydra.config.urls.self.issuer`| **Base URI of the oAuth server** | **https://sso.stackspin.example.net** | | `hydra.hydra.config.urls.login` | **URI that will be used for the login page** | **https://sso.stackspin.example.net/login** | | `hydra.hydra.config.urls.consent` | **URI that will be used for permission checks** | **https://sso.stackspin.example.net/consent** | -- GitLab