From 4cca1a2076ab7aa64b3d57d0397afaa3fa2ced56 Mon Sep 17 00:00:00 2001 From: Alex Vandiver Date: Mon, 26 Oct 2020 17:02:21 -0700 Subject: [PATCH] docs: Reword pgroonga sections. These were somewhat stilted as originally written; reword. --- docs/subsystems/full-text-search.md | 81 ++++++++++++----------------- 1 file changed, 34 insertions(+), 47 deletions(-) diff --git a/docs/subsystems/full-text-search.md b/docs/subsystems/full-text-search.md index 362bed8746..514c71f2b5 100644 --- a/docs/subsystems/full-text-search.md +++ b/docs/subsystems/full-text-search.md @@ -25,75 +25,62 @@ updating is done by deployed on the database server, but could be deployed on an application server instead. -## An optional full-text search implementation +## Multi-language full-text search -Zulip now supports using [PGroonga](https://pgroonga.github.io/) for -full-text search. PGroonga is a PostgreSQL extension that provides -full-text search feature. PostgreSQL's built-in full-text search -feature supports only one language at a time (in Zulip's case, -English). PGroonga supports all languages simultaneously, including -Japanese, Chinese and so on, all at once. We expect to migrate -Zulip's full-text search to only support PGroonga once we have tested -this new extension fully. +Zulip also supports using [PGroonga](https://pgroonga.github.io/) for +full-text search. While PostgreSQL's built-in full-text search feature +supports only one language at a time (in Zulip's case, English), the +PGroonga full-text search engine supports all languages +simultaneously, including Japanese and Chinese. Once we have tested +this new backend sufficiently, we expect to switch Zulip deployments +to always use PGroonga. -The following processes should be executed as the root user. Run: +### Enabling PGroonga - sudo -i +All steps in this section should be run as the `root` user; on most installs, this can be done by running `sudo -i`. -### How to enable full-text search across all languages +1. Alter the deployment setting: -This section describes how to enable using PGroonga to back the -full-text search feature. + crudini --set /etc/zulip/zulip.conf machine pgroonga enabled -To install PGroonga, add `pgroonga = enabled` in the `[machine]` -section in `/etc/zulip/zulip.conf`: +1. Update the deployment to respect that new setting: - [machine] - ... - pgroonga = enabled + /home/zulip/deployments/current/scripts/zulip-puppet-apply -And then run as root: +1. Edit `/etc/zulip/settings.py`, to add: - /home/zulip/deployments/current/scripts/zulip-puppet-apply + USING_PGROONGA = True -Then, add `USING_PGROONGA = True` in `/etc/zulip/settings.py`: +1. Apply the PGroonga migrations: - USING_PGROONGA = True + su zulip -c '/home/zulip/deployments/current/manage.py migrate pgroonga' -And apply the PGroonga migrations: + Note that the migration may take a long time, and users will be + unable to send new messages until the migration finishes. - su zulip -c '/home/zulip/deployments/current/manage.py migrate pgroonga' +1. Once the migrations are complete, restart Zulip: -Note that the migration may take a long time, and you can't send new -messages until the migration finishes. + su zulip -c '/home/zulip/deployments/current/scripts/restart-server' -Once the migrations are complete, restart Zulip: - su zulip -c '/home/zulip/deployments/current/scripts/restart-server' +### Disabling PGroonga -Now, you can use full-text search across all languages. +1. Remove the PGroonga migration: -### How to disable full-text search across all languages + su zulip -c '/home/zulip/deployments/current/manage.py migrate pgroonga zero' -This section describes how to disable full-text search feature based -on PGroonga. + If you intend to re-enable PGroonga later, you can skip this step, + at the cost of your Message table being slightly larger than it would + be otherwise. -If you want to fully remove PGroonga, first you need to remove the -PGroonga column (as above, this will take a long time and no messages -can be sent while it is running). If you intend to re-enable PGroonga -later, you can skip this step (at the cost of your Message table being -slightly larger than it would be otherwise). +1. Edit `/etc/zulip/settings.py`, editing the line containing `USING_PGROONGA` to read: - su zulip -c '/home/zulip/deployments/current/manage.py migrate pgroonga zero' + USING_PGROONGA = False -Then, set `USING_PGROONGA = False` in `/etc/zulip/settings.py`: +1. Restart Zulip: - USING_PGROONGA = False + su zulip -c '/home/zulip/deployments/current/scripts/restart-server' -And, restart Zulip: +1. Finally, remove the deployment setting: - su zulip -c '/home/zulip/deployments/current/scripts/restart-server' - -Now, full-text search feature based on PGroonga is disabled. If you'd -like, you can also remove the `pgroonga = enabled` line in -`/etc/zulip/zulip.conf` and uninstall the `pgroonga` packages. + crudini --del /etc/zulip/zulip.conf machine pgroonga