From d87cbbd2ca79565b13443a8ad7bd74fcebf4b0b2 Mon Sep 17 00:00:00 2001 From: jahway603 <64485701+jahway603@users.noreply.github.com> Date: Thu, 16 Feb 2023 10:38:16 -0500 Subject: [PATCH 1/3] Update database_maintenance_tools.md Included a blog post by Jackson Chen, which DID work when I followed it to perform Matrix Synapse Maintenance, versus the 2020 blog post by Victor Berger, which DID NOT work when performining maintenance. --- docs/usage/administration/database_maintenance_tools.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/usage/administration/database_maintenance_tools.md b/docs/usage/administration/database_maintenance_tools.md index 92b805d413cb..c3ef5062703a 100644 --- a/docs/usage/administration/database_maintenance_tools.md +++ b/docs/usage/administration/database_maintenance_tools.md @@ -1,4 +1,5 @@ -This blog post by Victor Berger explains how to use many of the tools listed on this page: https://levans.fr/shrink-synapse-database.html +This blog post by Jackson Chen explains how to use many of the tools listed on this page: https://jacksonchen666.com/posts/2022-12-03/14-33-00/ +This blog post by Victor Berger is from 2020 & outdated, so please only use as light reference https://levans.fr/shrink-synapse-database.html # List of useful tools and scripts for maintenance Synapse database: @@ -15,4 +16,4 @@ The purge history API allows server admins to purge historic events from their d Tool for compressing (deduplicating) `state_groups_state` table. ## [SQL for analyzing Synapse PostgreSQL database stats](useful_sql_for_admins.md) -Some easy SQL that reports useful stats about your Synapse database. \ No newline at end of file +Some easy SQL that reports useful stats about your Synapse database. From 2b02d115b23274f50baae0a9decef98c047b21ad Mon Sep 17 00:00:00 2001 From: jahway603 Date: Thu, 16 Feb 2023 17:07:22 -0500 Subject: [PATCH 2/3] Update database_maintenance_tools.md --- changelog.d/15083.doc | 1 + docs/usage/administration/database_maintenance_tools.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 changelog.d/15083.doc diff --git a/changelog.d/15083.doc b/changelog.d/15083.doc new file mode 100644 index 000000000000..24c445445add --- /dev/null +++ b/changelog.d/15083.doc @@ -0,0 +1 @@ +Update database maintenance tools documentation to include a recent blog post (originally written on Dec 3, 2022 and continues to receive updates, last update on Feb 7, 2023) to replace the commonly suggested blog post from 2020 which commands do not work. This new recent blog post was shared by its author in the Matrix Synapse Admin room after I had experienced tons of frustration not getting anything to work in the ancient blog post from 2020, so I'm updating this documentation to help others not get completely frustrated when maintaining their homeservers. Contributed by @jahway603. diff --git a/docs/usage/administration/database_maintenance_tools.md b/docs/usage/administration/database_maintenance_tools.md index c3ef5062703a..5ae0f80c3e4b 100644 --- a/docs/usage/administration/database_maintenance_tools.md +++ b/docs/usage/administration/database_maintenance_tools.md @@ -1,5 +1,5 @@ This blog post by Jackson Chen explains how to use many of the tools listed on this page: https://jacksonchen666.com/posts/2022-12-03/14-33-00/ -This blog post by Victor Berger is from 2020 & outdated, so please only use as light reference https://levans.fr/shrink-synapse-database.html +This blog post by Victor Berger is from 2020 & outdated, so please only use as light reference: https://levans.fr/shrink-synapse-database.html # List of useful tools and scripts for maintenance Synapse database: From 8a35dadb32541995871f833b0179ea2e6d71174a Mon Sep 17 00:00:00 2001 From: David Robertson Date: Mon, 20 Feb 2023 13:50:44 +0000 Subject: [PATCH 3/3] Rephrasing --- changelog.d/15083.doc | 2 +- docs/usage/administration/database_maintenance_tools.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/changelog.d/15083.doc b/changelog.d/15083.doc index 24c445445add..5385f4884aa1 100644 --- a/changelog.d/15083.doc +++ b/changelog.d/15083.doc @@ -1 +1 @@ -Update database maintenance tools documentation to include a recent blog post (originally written on Dec 3, 2022 and continues to receive updates, last update on Feb 7, 2023) to replace the commonly suggested blog post from 2020 which commands do not work. This new recent blog post was shared by its author in the Matrix Synapse Admin room after I had experienced tons of frustration not getting anything to work in the ancient blog post from 2020, so I'm updating this documentation to help others not get completely frustrated when maintaining their homeservers. Contributed by @jahway603. +Refer to a more recent blog post on the [Database Maintenance Tools](https://matrix-org.github.io/synapse/latest/usage/administration/database_maintenance_tools.html) page. Contributed by @jahway603. diff --git a/docs/usage/administration/database_maintenance_tools.md b/docs/usage/administration/database_maintenance_tools.md index 5ae0f80c3e4b..e19380db07be 100644 --- a/docs/usage/administration/database_maintenance_tools.md +++ b/docs/usage/administration/database_maintenance_tools.md @@ -1,5 +1,4 @@ -This blog post by Jackson Chen explains how to use many of the tools listed on this page: https://jacksonchen666.com/posts/2022-12-03/14-33-00/ -This blog post by Victor Berger is from 2020 & outdated, so please only use as light reference: https://levans.fr/shrink-synapse-database.html +_This [blog post by Jackson Chen](https://jacksonchen666.com/posts/2022-12-03/14-33-00/) (Dec 2022) explains how to use many of the tools listed on this page. There is also an [earlier blog by Victor Berger](https://levans.fr/shrink-synapse-database.html) (June 2020), though this may be outdated in places._ # List of useful tools and scripts for maintenance Synapse database: