diff options
Diffstat (limited to 'docs/configuration/storage/mariadb.md')
| -rw-r--r-- | docs/configuration/storage/mariadb.md | 114 | 
1 files changed, 0 insertions, 114 deletions
diff --git a/docs/configuration/storage/mariadb.md b/docs/configuration/storage/mariadb.md deleted file mode 100644 index 8756e6b3c..000000000 --- a/docs/configuration/storage/mariadb.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -layout: default -title: MariaDB -parent: Storage Backends -grand_parent: Configuration -nav_order: 1 ---- - -# MariaDB - -The MySQL storage provider also serves as a MariaDB provider. - -## Version support - -We recommend using the latest version of MariaDB that is officially supported by the MariaDB developers. We also suggest -checking out [PostgreSQL](postgres.md) as an alternative. - -The oldest version of MariaDB that has been tested is 10.6. If using 10.6 you may be required to adjust the  -`explicit_defaults_for_timestamp` setting. This will be evident when the container starts with an error similar to -`Error 1067: Invalid default value for 'exp'`. You can adjust this setting in the mysql.cnf file like so: - -```cnf -[mysqld] -explicit_defaults_for_timestamp = 1 -``` - -## Configuration - -```yaml -storage: -  encryption_key: a_very_important_secret -  mysql: -    host: 127.0.0.1 -    port: 3306 -    database: authelia -    username: authelia -    password: mypassword -``` - -## Options - -### encryption_key -See the [encryption_key docs](./index.md#encryption_key). - -### host -<div markdown="1"> -type: string -{: .label .label-config .label-purple }  -required: yes -{: .label .label-config .label-red } -</div> - -The database server host. - -If utilising an IPv6 literal address it must be enclosed by square brackets and quoted: -```yaml -host: "[fd00:1111:2222:3333::1]" -``` - -### port -<div markdown="1"> -type: integer -{: .label .label-config .label-purple }  -default: 3306 -{: .label .label-config .label-blue } -required: no -{: .label .label-config .label-green } -</div> - -The port the database server is listening on. - -### database -<div markdown="1"> -type: string -{: .label .label-config .label-purple } -required: yes -{: .label .label-config .label-red } -</div> - -The database name on the database server that the assigned [user](#username) has access to for the purpose of -**Authelia**. - -### username -<div markdown="1"> -type: string -{: .label .label-config .label-purple } -required: yes -{: .label .label-config .label-red } -</div> - -The username paired with the password used to connect to the database. - -### password -<div markdown="1"> -type: string -{: .label .label-config .label-purple } -required: yes -{: .label .label-config .label-red } -</div> - -The password paired with the username used to connect to the database. Can also be defined using a -[secret](../secrets.md) which is also the recommended way when running as a container. - -### timeout -<div markdown="1"> -type: duration -{: .label .label-config .label-purple } -default: 5s -{: .label .label-config .label-blue } -required: no -{: .label .label-config .label-green } -</div> - -The SQL connection timeout.  | 
