From 39f53e81d0d47d76a28787b9b05a7152cca90a16 Mon Sep 17 00:00:00 2001 From: Justin Croonenberghs Date: Sun, 19 Mar 2023 13:42:41 -0500 Subject: [PATCH] Update sliding sync doc for external DB users * fixes #2586 --- docs/configuring-playbook-sliding-sync-proxy.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 49e0483a3..a0eb36ba4 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -40,6 +40,17 @@ matrix_sliding_sync_enabled: true After potentially [adjusting DNS records](#adjusting-dns-records) and configuring the playbook, run the [installation](installing.md) command again: `just install-all`. +### External databases + +Please note that, if your setup utilizes an external database, you must also establish configuration for the sliding sync proxy. Alter the defaults below to suit your configuration: + +```yaml +matrix_sliding_sync_database_username: 'matrix_sliding_sync' +matrix_sliding_sync_database_password: '' +matrix_sliding_sync_database_hostname: '' +matrix_sliding_sync_database_port: 5432 +matrix_sliding_sync_database_name: 'matrix_sliding_sync' +``` ## Usage