commit: 846e0ae2cd58a055a59b7e9c8f14d624dae9c8eb
parent 928fb6d2e60f2db6eee8d46d3b69067f6f63eeb2
Author: Phantasm <phantasm@centrum.cz>
Date: Sat, 13 Sep 2025 18:05:12 +0200
docs rum: Update idx size, add command for OTP install, recommend vacuum
Diffstat:
2 files changed, 17 insertions(+), 3 deletions(-)
diff --git a/changelog.d/docs-rum-otp-vacuum.change b/changelog.d/docs-rum-otp-vacuum.change
@@ -0,0 +1 @@
+Docs RUM index: Add OTP install command, update index size expectation and recommend VACUUM FULL
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
@@ -906,16 +906,29 @@ config :logger, :console,
* `rum_enabled`: If RUM indexes should be used. Defaults to `false`.
-RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. While they may eventually be mainlined, for now they have to be installed as a PostgreSQL extension from https://github.com/postgrespro/rum.
+RUM indexes are an alternative indexing scheme that is not included in PostgreSQL by default. While they may eventually be mainlined, for now they have to be installed as a PostgreSQL extension from [https://github.com/postgrespro/rum](https://github.com/postgrespro/rum).
-Their advantage over the standard GIN indexes is that they allow efficient ordering of search results by timestamp, which makes search queries a lot faster on larger servers, by one or two orders of magnitude. They take up around 3 times as much space as GIN indexes.
+Their advantage over the standard GIN indexes is that they allow efficient ordering of search results by timestamp, which makes search queries a lot faster on larger servers, by one or two orders of magnitude. They take up around 3-4 times as much space as GIN indexes.
To enable them, both the `rum_enabled` flag has to be set and the following special migration has to be run:
-`mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
+ * Source install:
+ - Stop Pleroma
+ - `mix ecto.migrate --migrations-path priv/repo/optional_migrations/rum_indexing/`
+ * OTP install:
+ - Stop Pleroma
+ - `pleroma_ctl migrate --migrations-path <install location>/lib/pleroma-<version>/priv/repo/optional_migrations/rum_indexing/`
This will probably take a long time.
+!!! note
+ It is recommended to `VACUUM FULL` the objects table after the migration has completed, to do that run:
+ ```
+ # sudo -Hu postgres vacuumdb --full --analyze -t objects <pleroma DB name>
+ ```
+
+Now you can start Pleroma back up.
+
## Alternative client protocols
### BBS / SSH access
