authelia/docs/content/en/configuration/prologue/migration.md

106 lines
4.1 KiB
Markdown
Raw Normal View History

---
title: "Migration"
description: "Information regarding configuration migration."
lead: "An introduction into configuring Authelia."
2022-06-28 05:27:14 +00:00
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
menu:
configuration:
parent: "prologue"
weight: 100300
toc: true
aliases:
- /docs/configuration/migration.html
---
This section discusses the change to the configuration over time. Since v4.36.0 the migration process is automatically
performed where possible in memory (the file is unchanged). The automatic process generates warnings and the automatic
migrations are disabled in major version bumps.
If you're running a version prior to v4.36.0 this it may require manual migration by the administrator. Typically this
only occurs when a configuration key is renamed or moved to a more appropriate location.
## Format
The migrations are formatted in a table with the old key and the new key. Periods indicate a different section which can
be represented in [YAML] as a dictionary i.e. it's indented.
In our table `server.host` with a value of `0.0.0.0` is represented in [YAML] like this:
```yaml
server:
host: 0.0.0.0
```
## Migrations
### 4.36.0
Automatic mapping was introduced in this version.
The following changes occurred in 4.30.0:
| Previous Key | New Key |
|:---------------------------------------------:|:---------------------------------------------:|
| authentication_backend.disable_reset_password | authentication_backend.password_reset.disable |
### 4.33.0
The options deprecated in version [4.30.0](#4300) have been fully removed as per our deprecation policy and warnings
logged for users.
### 4.30.0
The following changes occurred in 4.30.0:
| Previous Key | New Key |
|:-------------:|:----------------------:|
| host | server.host |
| port | server.port |
| tls_key | server.tls.key |
| tls_cert | server.tls.certificate |
| log_level | log.level |
| log_file_path | log.file_path |
| log_format | log.format |
*__Please Note:__ you can no longer define secrets for providers that you are not using. For example if you're using the
[filesystem notifier](../notifications/introduction.md) you must ensure that the `AUTHELIA_NOTIFIER_SMTP_PASSWORD_FILE`
environment variable or other environment variables set. This also applies to other providers like
[storage](../storage/introduction.md) and [authentication backend](../first-factor/introduction.md).*
#### Kubernetes 4.30.0
*__Please Note:__ if you're using Authelia with Kubernetes and are not using the provided
[helm chart](https://charts.authelia.com) you will be required to
2022-12-07 09:43:02 +00:00
[configure the enableServiceLinks](../../integration/kubernetes/introduction.md#enable-service-links) option.*
### 4.25.0
The following changes occurred in 4.25.0:
| Previous Key | New Key |
|:-----------------------------------------------:|:-----------------------------------------------:|
| authentication_backend.ldap.tls.skip_verify | authentication_backend.ldap.tls.skip_verify |
| authentication_backend.ldap.minimum_tls_version | authentication_backend.ldap.tls.minimum_version |
| notifier.smtp.disable_verify_cert | notifier.smtp.tls.skip_verify |
| notifier.smtp.trusted_cert | certificates_directory |
*__Please Note:__ `certificates_directory` is not a direct replacement for the `notifier.smtp.trusted_cert`, instead
of being the path to a specific file it is a path to a directory containing certificates trusted by Authelia. This
affects other services like LDAP as well.*
### 4.7.0
The following changes occurred in 4.7.0:
| Previous Key | New Key |
|:------------:|:---------:|
| logs_level | log_level |
| logs_file | log_file |
2022-12-07 09:43:02 +00:00
*__Please Note:__ The new keys also changed in [4.30.0](#4300) so you will need to update them to the new values if you
are using [4.30.0](#4300) or newer instead of the new keys listed here.*
[YAML]: https://yaml.org/