habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: improve read replica docs (#9828)

Browse Source 
Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L
2024-05-24 18:26:41 +02:00
committed by GitHub
parent 4f1d49417c
commit 2cff3d15e7
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
website/docs/installation/configuration.mdx
View File

@ -77,7 +77,13 @@ To check if your config has been applied correctly, you can run the following co
- `AUTHENTIK_POSTGRESQL__SSLCERT`: Path to x509 client certificate to authenticate to server
- `AUTHENTIK_POSTGRESQL__SSLKEY`: Path to private key of `SSLCERT` certificate
Additionally, databases used only for read operations can be configured. Increase the number in the following configuration variables for each read replica.
All PostgreSQL settings, apart from `USE_PGBOUNCER` and `USE_PGPOOL`, support hot-reloading. Adding and removing read replicas doesn't support hot-reloading.
### 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.
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
@ -89,9 +95,7 @@ Additionally, databases used only for read operations can be configured. Increas
- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLCERT`: same as above
- `AUTHENTIK_POSTGRESQL__READ_REPLICAS__0__SSLKEY`: same as above
Note that `USE_PGBOUNCER` and `USE_PGPOOL` are inherited from the main database configuration and are not overridable per read replica. By default, if read replicas are configured, the main database is not used for reads. If you'd like it to be included for reads, add it as a read replica.
All PostgreSQL settings, apart from `USE_PGBOUNCER` and `USE_PGPOOL`, support hot-reloading. Adding and removing read replicas doesn't support hot-reloading.
Note that `USE_PGBOUNCER` and `USE_PGPOOL` are inherited from the main database configuration and are _not_ overridable on read replicas.
## Redis Settings