From 4da18b5f0c1cf770f565a2113071e3d4025577fd Mon Sep 17 00:00:00 2001 From: Jens L Date: Sun, 19 Mar 2023 18:56:03 +0100 Subject: [PATCH] website/docs: improve docs for configuring event retention (#5002) Signed-off-by: Jens Langhammer #2723 --- website/docs/events/index.md | 8 +++++++- website/docs/index.mdx | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/website/docs/events/index.md b/website/docs/events/index.md index d8caf4b3c..49ba40fc3 100644 --- a/website/docs/events/index.md +++ b/website/docs/events/index.md @@ -6,7 +6,13 @@ Events are authentik's built-in logging system. Whenever any of the following ac Certain information is stripped from events, to ensure no passwords or other credentials are saved in the log. -If you want to forward these events to another application, forward the log output of all authentik containers. Every event creation is logged with the log level "info". +## Event retention + +The event retention is configured on a per-tenant level, with the default being set to 365 days. For events where a related tenant cannot be found, the retention is also set to 365 days. + +If you want to forward these events to another application, forward the log output of all authentik containers. Every event creation is logged with the log level "info". For this configuration, it is also recommended to set the internal retention pretty low (for example, `days=1`). + +## Event actions ### `login` diff --git a/website/docs/index.mdx b/website/docs/index.mdx index 8720ee40c..aade68adc 100755 --- a/website/docs/index.mdx +++ b/website/docs/index.mdx @@ -5,7 +5,7 @@ slug: / ## What is authentik? -authentik is an open-source Identity Provider, focused on flexibility and versatility. With authentik, site administrators, application developers, and security engineers a dependable and secure solution for authentication in almost any type of environment. There are robust recovery actions available for the users and applications, including user profile and password management. You can quickly edit, deactivate, or even impersonate a user profile, and set a new passowrd for new users or reset an existing password. +authentik is an open-source Identity Provider, focused on flexibility and versatility. With authentik, site administrators, application developers, and security engineers a dependable and secure solution for authentication in almost any type of environment. There are robust recovery actions available for the users and applications, including user profile and password management. You can quickly edit, deactivate, or even impersonate a user profile, and set a new password for new users or reset an existing password. You can use authentik in an existing environment to add support for new protocols, so introducing authentik to your current tech stack doesn't present re-architecting challenges. We already support all of the major providers, such as OAuth2, SAML, LDAP, and SCIM, so you can pick the protocol that you need for each application.