Files
authentik/website/docs/core/settings.md
Jens L 0b4822c1e3 website/docs: maintenance, re-add system settings (#9026)
* update screenshots

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* unrelated: fix api schema

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* required working anchors

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* add system settings page

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* fix broken anchors

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* use client-side-redirects plugin

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

* Optimised images with calibre/image-actions

* Revert "use client-side-redirects plugin"

This reverts commit 3103433617.

Signed-off-by: Jens Langhammer <jens@goauthentik.io>

---------

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
Co-authored-by: authentik-automation[bot] <135050075+authentik-automation[bot]@users.noreply.github.com>
2024-03-26 14:42:07 +01:00

2.3 KiB

title
title
System Settings

These settings are similar to the configuration options listed here, however they can only be adjusted through the authentik Admin interface or API.

Avatars

Configure how authentik should show avatars for users. Following values can be set:

Default: gravatar,initials

  • none: Disables per-user avatars and just shows a 1x1 pixel transparent picture

  • gravatar: Uses gravatar with the user's email address

  • initials: Generated avatars based on the user's name

  • Any URL: If you want to use images hosted on another server, you can set any URL.

    Additionally, these placeholders can be used:

    • %(username)s: The user's username
    • %(mail_hash)s: The email address, md5 hashed
    • %(upn)s: The user's UPN, if set (otherwise an empty string)

You can also use an attribute path like attributes.something.avatar, which can be used in combination with the file field to allow users to upload custom avatars for themselves.

Multiple modes can be set, and authentik will fallback to the next mode when no avatar could be found. For example, setting this to gravatar,initials will attempt to get an avatar from Gravatar, and if the user has not configured on there, it will fallback to a generated avatar.

Allow users to change name

Enable the ability for users to change their name, defaults to true.

Allow users to change email

Enable the ability for users to change their Email address, defaults to false.

Allow users to change username

Enable the ability for users to change their Usernames, defaults to false.

Event retention

Configure how long Events are retained for within authentik. Default value is days=365. When forwarding events to an external application, this value can be decreased. When changing this value, only new events are affected.

This option configures the footer links on the flow executor pages.

The setting can be used as follows:

[{ "name": "Link Name", "href": "https://goauthentik.io" }]

GDPR compliance

When enabled, all the events caused by a user will be deleted upon the user's deletion. Defaults to true.

Impersonation

Globally enable/disable impersonation. Defaults to true.