From 6a79b3a4afdd4d9d99cc91a03000158dca858078 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Fri, 14 Jun 2024 15:03:27 -0500 Subject: [PATCH] website/docs: add more info about multiple replicas (#10117) * add info * tweak * removed same as --------- Co-authored-by: Tana M Berry --- website/docs/installation/configuration.mdx | 22 +++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/website/docs/installation/configuration.mdx b/website/docs/installation/configuration.mdx index c58d99e02a..403cd767b8 100644 --- a/website/docs/installation/configuration.mdx +++ b/website/docs/installation/configuration.mdx @@ -81,19 +81,21 @@ All PostgreSQL settings, apart from `USE_PGBOUNCER` and `USE_PGPOOL`, support ho ### Read replicas -Additional databases used only for read operations can be configured. Increase the number (by default `0`) in the following configuration settings for each read replica. +You can configure additional read replica databases that are used only for read operations. To configure authentik to use replicas, add the settings below to your [configuration file](./configuration.mdx#set-your-environment-variables). If you have multiple replicas, add additional settings for each replica, replacing the default `0` with a unique value for each additional replica. If read replicas are configured, the main database is not used for reads. If you'd like the main database to be included for reads, add it as a read replica. -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__HOST`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__NAME`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__USER`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PORT`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PASSWORD`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLMODE`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLROOTCERT`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLCERT`: same as above -- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLKEY`: same as above +The same PostgreSQL settings as described above are used for each read replica. + +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__HOST` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__NAME` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__USER` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PORT` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__PASSWORD` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLMODE` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLROOTCERT` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLCERT` +- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLKEY` Note that `USE_PGBOUNCER` and `USE_PGPOOL` are inherited from the main database configuration and are _not_ overridable on read replicas.