Synapse database maintenance tools

List of useful tools and scripts for maintenance Synapse database:

Purge Remote Media API

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 -atime +365 -delete This will delete media that hasn't been accessed in 365 days.

Purge History API

The purge history API allows server admins to purge historic events from their database, reclaiming disk space.

synapse_janitor.sql

Cleans a synapse Postgres database of deleted messages and abandoned rooms.

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

Tool for compressing (deduplicating) state_groups_state table.

SQL queries for analyze Matrix Synapse database

Some easy SQL queries that reports useful stat about Matrix Synapse database.