release notes

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
This commit is contained in:
Marc 'risson' Schmitt 2024-01-16 05:44:29 +01:00
parent 2d04fa0de2
commit 3139774b66
No known key found for this signature in database
GPG Key ID: 9C3FA22FABF1AA8D
1 changed files with 40 additions and 1 deletions

View File

@ -1,6 +1,6 @@
---
title: Release 2024.1
slug: "/releases/2024.1"
slug: /releases/2024.1
---
## Breaking changes
@ -23,6 +23,39 @@ slug: "/releases/2024.1"
Applications which require will need their configuration update to include the `offline_access` scope mapping.
- Tenants have been renamed to brands
The API endpoints associated with brands have also been renamed.
Blueprints using `authentik_tenants.tenant` will need to be changed to use `authentik_brands.brand`.
- The following config options have been removed from the config file and can now be set using the admin interface (under **System** > **Settings**) or the API:
- `avatars`, `AUTHENTIK_AVATARS`
- `default_user_change_name`, `AUTHENTIK_DEFAULT_USER_CHANGE_NAME`
- `default_user_change_email`, `AUTHENTIK_DEFAULT_USER_CHANGE_EMAIL`
- `default_user_change_username`, `AUTHENTIK_DEFAULT_USER_CHANGE_USERNAME`
- `gdpr_compliance`, `AUTHENTIK_GDPR_COMPLIANCE`
- `impersonation`, `AUTHENTIK_IMPERSONATION`
- `footer_links`, `AUTHENTIK_FOOTER_LINKS`
- `reputation_expiry`, `AUTHENTIK_REPUTATION__EXPIRY`
To upgrade, leave those options in your config, then upgrade authentik. The options are now saved in the database and you can remove them from your config.
- The event retention settings configured in brands (previously tenants, see above) has been removed and is now a system settings, managed in the admin interface or via the API (see above).
There is no built-in migration path for this change. If you set something other than the default (`days=365`), you will need to update the setting in the admin interface.
- Icons are now in a `public/` subfolder
If your media folder is `/media`, icons are now stored in `/media/public`. authentik will automatically migrate the icons upon upgrading.
- The shorthand parameter for `--stage`, `-s` for the `ak test_email` command has been changed to `-S`
- authentik now uses PostgreSQL schemas other than `public`.
If you have a custom PostgreSQL deployment, please ensure that the authentik user is allowed to create schemas. Usually, if the authentik user is owner of the database, it already can.
## New features
- "Pretend user exists" option for Identification stage
@ -33,6 +66,12 @@ slug: "/releases/2024.1"
Media files can now be stored on S3. Follow the [setup guide](../../installation/storage-s3.md) to get started.
- Tenancy
This feature is still in alpha stage. Use at your own risk.
It allows for authentik operators to manage several authentik installations without having to deploy additional instances.
## Upgrading
This release does not introduce any new requirements.