From fc999f55722d628c7bdbece8cb5b24a850a35ba1 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Thu, 23 Dec 2021 11:30:50 +0000 Subject: [PATCH] Updated Synapse database maintenance tools (markdown) --- Synapse-database-maintenance-tools.md | 42 +-------------------------- 1 file changed, 1 insertion(+), 41 deletions(-) diff --git a/Synapse-database-maintenance-tools.md b/Synapse-database-maintenance-tools.md index 5760d8d..d22efab 100644 --- a/Synapse-database-maintenance-tools.md +++ b/Synapse-database-maintenance-tools.md @@ -1,41 +1 @@ -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 - -# List of useful tools and scripts for maintenance Synapse database: - -## [Purge Remote Media API](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_remote_media.rst) -The purge remote media API allows server admins to purge old cached remote media. - -#### Purge local media - -There is no purge API for local media because you may be the only one with a copy. If you are sure you want to delete local media you could use something like the following to delete media that hasn't been accessed in a while. - -``` -find /path/to/synapse/media_store/local_content -atime +365 -delete -find /path/to/synapse/media_store/local_thumbnails -atime +365 -delete -``` - -This will delete media that hasn't been accessed in 365 days. - -**Warning, check noatime flag**: You also have to double-check that the filesystem where synapse's media store don't have [noatime flag](https://unix.stackexchange.com/questions/219015/how-to-disable-access-time-settings-in-debian-linux/219017#219017). Check it with `mount`, `noatime` is something that is usually enabled by default to reduce read-write operations in the filesystem for a feature is not so demanded. - -## [Purge History API](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/purge_history_api.rst) -The purge history API allows server admins to purge historic events from their database, reclaiming disk space. - -## [synapse_janitor.sql](https://github.com/xwiki-labs/synapse_scripts) - -- this project is [unmantained and dangerous](https://github.com/xwiki-labs/synapse_scripts#unmaintained-and-dangerous) -- USE WITH CAUTION. It may cause database corruption (see https://github.com/matrix-org/synapse/issues/7305 for example). -- ["Our team hasn't used any of these scripts for some time (possibly years) (...) if anyone wants to volunteer to maintain this repo I'd be happy to transfer ownership.](https://github.com/xwiki-labs/synapse_scripts/pull/12#issuecomment-617275345) - -Cleans a synapse Postgres database of deleted messages and abandoned rooms. - -## [synapse-delurlcache](https://github.com/zzottel/synapse-delurlcache) -Delete images and thumbnails created by URL previews in Synapse - -NOTE: This is not required anymore as of Synapse 0.24, it now deletes those images by itself. - -## [synapse-compress-state](https://github.com/matrix-org/rust-synapse-compress-state) -Tool for compressing (deduplicating) `state_groups_state` table. - -## [SQL for analyzing Synapse PostgreSQL database stats](https://github.com/matrix-org/synapse/wiki/SQL-for-analyzing-Synapse-PostgreSQL-database-stats) -Some easy SQL that reports useful stat about Matrix Synapse database. \ No newline at end of file +This content has been moved to https://matrix-org.github.io/synapse/latest/usage/administration/database_maintenance_tools.html. \ No newline at end of file