From 32e64faffe38d3a1be2994e6fc8cec174ee3ef45 Mon Sep 17 00:00:00 2001 From: David Robertson Date: Mon, 24 Oct 2022 14:03:10 +0100 Subject: Move admin docs to admin section (excluding admin api) --- docs/administration/database_maintenance_tools.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/administration/database_maintenance_tools.md (limited to 'docs/administration/database_maintenance_tools.md') diff --git a/docs/administration/database_maintenance_tools.md b/docs/administration/database_maintenance_tools.md new file mode 100644 index 0000000000..c6cf0c990e --- /dev/null +++ b/docs/administration/database_maintenance_tools.md @@ -0,0 +1,18 @@ +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](../../administration/admin_api/media_admin_api.md#purge-remote-media-api) +The purge remote media API allows server admins to purge old cached remote media. + +## [Purge Local Media API](../../administration/admin_api/media_admin_api.md#delete-local-media) +This API deletes the *local* media from the disk of your own server. + +## [Purge History API](../../administration/admin_api/purge_history_api.md) +The purge history API allows server admins to purge historic events from their database, reclaiming disk space. + +## [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](useful_sql_for_admins.md) +Some easy SQL that reports useful stats about your Synapse database. \ No newline at end of file -- cgit 1.5.1