RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
authelia/docs/content/en/reference/integrations/database-integrations.md

3.9 KiB
Raw Blame History

title description lead date draft images menu weight toc
Database Integrations A database integration reference guide This section contains a database integration reference guide for Authelia. 2022-11-10T11:03:47+11:00 false
reference
parent
integrations
320 true

We generally recommend using PostgreSQL for a database. If high availability is not a consideration we also support SQLite3.

PostgreSQL

The only current support criteria for PostgreSQL at present is that the version you're using is supported by the PostgreSQL developers. See their Versioning Policy for more information.

We generally perform integration testing against the latest supported version of PostgreSQL and that is generally the recommended version for new installations.

MySQL

MySQL and MariaDB are both supported as part of the MySQL implementation. This is generally discouraged as PostgreSQL is widely considered as a significantly better database engine. If you choose to go with MySQL, we recommend specifically using the MariaDB backend.

MySQL comes with some rigid support requirements in addition to the standard requirements for us supporting a third party.

  1. Must both support the InnoDB engine and this engine must be the default engine.
  2. Must support the utf8mb4 charset.
  3. Must support the utf8mb4_unicode_520_ci collation.
  4. Must support maximum index size of no less than 2048 bytes. The default maximum index size for the InnoDB engine is 3072 bytes on:
    1. MySQL 8.0 or later.
    2. MySQL 5.7 provided innodb_large_prefix or later.
    3. MariaDB 10.3 or later.
  5. Must support ANSI standard time behaviours. See ANSI standard time behaviours.

We generally perform integration testing against the latest supported version of MySQL and MariaDB, and the latest supported version of MariaDB is generally the recommended version for new installations.

Specific Notes

InnoDB Large Prefixes

This can be configured in the MySQL configuration file by setting the innodb_large_prefix value to on. According to the Oracle documentation this is the default behaviour in MySQL 5.7 and it can't be turned off in MySQL 8.0 or in MariaDB 10.3 and later.

[mysqld]
innodb_large_prefix = ON

ANSI standard time behaviours

This can be configured in the MySQL configuration file by setting the explicit_defaults_for_timestamp value to on. According to the Oracle documentation this is the default behaviour in MySQL 5.7 and MySQL 8.0. This is however not the default behaviour in MariaDB before 10.10.

[mysqld]
explicit_defaults_for_timestamp = ON

Vendor Supported Versions

MariaDB Vendor Supported Versions

See the MariaDB Server Releases for more information.

MySQL Vendor Supported Versions

See the MySQL Supported Platforms for information on which versions and platforms they support.