habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: maintenance, re-add system settings (#9026)

Browse Source 
* 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>
This commit is contained in:
Jens L
2024-03-26 14:42:07 +01:00
committed by GitHub
parent fcb82c243f
commit 0b4822c1e3
19 changed files with 68 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
website/docs/core/settings.md Normal file
View File

@ -0,0 +1,60 @@
---
title: System Settings
---
These settings are similar to the configuration options listed [here](../installation/configuration.mdx), 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](../events/index.md) 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.
### Footer links
This option configures the footer links on the flow executor pages.
The setting can be used as follows:
```json
[{ "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`.

2
website/docs/releases/2023/v2023.2.md
View File

@ -21,7 +21,7 @@ slug: "/releases/2023.2"
- Generated avatars, multiple avatar modes
authentik now supports multiple avatar modes, and will use the next configured mode when a mode doesn't have an avatar. For example, the new default configuration attempts to use gravatar, but if the user's email does not have a gravatar setup, it will instead use the new generated avatars. See [Configuration](../../installation/configuration.mdx#authentik_avatars)
authentik now supports multiple avatar modes, and will use the next configured mode when a mode doesn't have an avatar. For example, the new default configuration attempts to use gravatar, but if the user's email does not have a gravatar setup, it will instead use the new generated avatars. See [Configuration](../../core/settings.md#avatars)
## Upgrading