From 2520c92b7823d501816c1871a940ed1cec55d0a0 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Thu, 23 Dec 2021 18:51:18 +0100 Subject: [PATCH] website/docs: add additional docs Signed-off-by: Jens Langhammer --- web/src/locales/en.po | 5 ++++- web/src/locales/fr_FR.po | 5 ++++- web/src/locales/pseudo-LOCALE.po | 5 ++++- .../stages/user_login/UserLoginStageForm.ts | 2 +- website/docs/flow/stages/user_login.md | 16 ++++++++++++++++ website/docs/flow/stages/user_write.md | 2 ++ 6 files changed, 31 insertions(+), 4 deletions(-) diff --git a/web/src/locales/en.po b/web/src/locales/en.po index b715719d3..9193f47e8 100644 --- a/web/src/locales/en.po +++ b/web/src/locales/en.po @@ -21,10 +21,13 @@ msgstr "" #: src/pages/providers/oauth2/OAuth2ProviderForm.ts #: src/pages/providers/proxy/ProxyProviderForm.ts #: src/pages/providers/saml/SAMLProviderForm.ts -#: src/pages/stages/user_login/UserLoginStageForm.ts msgid "(Format: hours=-1;minutes=-2;seconds=-3)." msgstr "(Format: hours=-1;minutes=-2;seconds=-3)." +#: src/pages/stages/user_login/UserLoginStageForm.ts +msgid "(Format: hours=1;minutes=2;seconds=3)." +msgstr "(Format: hours=1;minutes=2;seconds=3)." + #: src/elements/events/ObjectChangelog.ts #: src/elements/events/UserEvents.ts #: src/elements/user/SessionList.ts diff --git a/web/src/locales/fr_FR.po b/web/src/locales/fr_FR.po index 3d0444707..653b30abe 100644 --- a/web/src/locales/fr_FR.po +++ b/web/src/locales/fr_FR.po @@ -27,10 +27,13 @@ msgstr "" #: src/pages/providers/oauth2/OAuth2ProviderForm.ts #: src/pages/providers/proxy/ProxyProviderForm.ts #: src/pages/providers/saml/SAMLProviderForm.ts -#: src/pages/stages/user_login/UserLoginStageForm.ts msgid "(Format: hours=-1;minutes=-2;seconds=-3)." msgstr "(Format : heures=-1;minutes=-2;seconds=-3)" +#: src/pages/stages/user_login/UserLoginStageForm.ts +msgid "(Format: hours=1;minutes=2;seconds=3)." +msgstr "" + #: src/elements/events/ObjectChangelog.ts #: src/elements/events/UserEvents.ts #: src/elements/user/SessionList.ts diff --git a/web/src/locales/pseudo-LOCALE.po b/web/src/locales/pseudo-LOCALE.po index c91201f00..3601b4324 100644 --- a/web/src/locales/pseudo-LOCALE.po +++ b/web/src/locales/pseudo-LOCALE.po @@ -21,10 +21,13 @@ msgstr "" #: src/pages/providers/oauth2/OAuth2ProviderForm.ts #: src/pages/providers/proxy/ProxyProviderForm.ts #: src/pages/providers/saml/SAMLProviderForm.ts -#: src/pages/stages/user_login/UserLoginStageForm.ts msgid "(Format: hours=-1;minutes=-2;seconds=-3)." msgstr "" +#: src/pages/stages/user_login/UserLoginStageForm.ts +msgid "(Format: hours=1;minutes=2;seconds=3)." +msgstr "" + #: src/elements/events/ObjectChangelog.ts #: src/elements/events/UserEvents.ts #: src/elements/user/SessionList.ts diff --git a/web/src/pages/stages/user_login/UserLoginStageForm.ts b/web/src/pages/stages/user_login/UserLoginStageForm.ts index 73c92a773..7d0f36cd3 100644 --- a/web/src/pages/stages/user_login/UserLoginStageForm.ts +++ b/web/src/pages/stages/user_login/UserLoginStageForm.ts @@ -69,7 +69,7 @@ export class UserLoginStageForm extends ModelForm { ${t`Determines how long a session lasts. Default of 0 seconds means that the sessions lasts until the browser is closed.`}

- ${t`(Format: hours=-1;minutes=-2;seconds=-3).`} + ${t`(Format: hours=1;minutes=2;seconds=3).`}

diff --git a/website/docs/flow/stages/user_login.md b/website/docs/flow/stages/user_login.md index 5c7531040..186a54cad 100644 --- a/website/docs/flow/stages/user_login.md +++ b/website/docs/flow/stages/user_login.md @@ -5,3 +5,19 @@ title: User login stage This stage attaches a currently pending user to the current session. It can be used after `user_write` during an enrollment flow, or after a `password` stage during an authentication flow. + +## Session duration + +By default, the authentik session expires when you close your browser (*seconds=0*). + +You can set the session to expire after any duration using the syntax of `hours=1,minutes=2,seconds=3`. The following keys are allowed: + +- Microseconds +- Milliseconds +- Seconds +- Minutes +- Hours +- Days +- Weeks + +All values accept floating-point values. diff --git a/website/docs/flow/stages/user_write.md b/website/docs/flow/stages/user_write.md index 42fbbcfa6..39f072fca 100644 --- a/website/docs/flow/stages/user_write.md +++ b/website/docs/flow/stages/user_write.md @@ -3,3 +3,5 @@ title: User write stage --- This stages writes data from the current context to the current pending user. If no user is pending, a new one is created. + +Newly created users can be created as inactive and can be assigned to a selected group.