From b6cce494a8f9e3828cc866e5378e0282e690ae5f Mon Sep 17 00:00:00 2001 From: Mateusz Mandera Date: Fri, 28 Jul 2023 20:04:04 +0200 Subject: [PATCH] docs: Add a warning about restarting individual services. restart-server is almost always the way to go, so we can be clearer about it. --- docs/production/troubleshooting.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/production/troubleshooting.md b/docs/production/troubleshooting.md index 08152df091..1688290a08 100644 --- a/docs/production/troubleshooting.md +++ b/docs/production/troubleshooting.md @@ -107,8 +107,13 @@ isn't running. If you don't see relevant logs in After you change configuration in `/etc/zulip/settings.py` or fix a misconfiguration, you will often want to restart the Zulip -application. Running `scripts/restart-server` will restart all of -Zulip's services; if you want to restart just one of them, you can use +application. In order to restart all of Zulip's services, you can use: + +```bash +/home/zulip/deployments/current/scripts/restart-server +``` + +If you want to restart just one of them, you can use `supervisorctl`: ```bash @@ -116,6 +121,15 @@ Zulip's services; if you want to restart just one of them, you can use supervisorctl restart zulip-django ``` +:::{warning} +A configuration file might be used by multiple services, so generally +`scripts/restart-server` is the correct tool to use for reloading +purposes. Only use `supervisorctl restart` for an individual service +if you're confident that this specific service requires restarting. +In particular, it is not the right tool for applying settings changes +in `/etc/zulip/settings.py` and may cause inconsistent behavior. +::: + ### Stopping services with `supervisorctl stop` Similarly, while stopping all of Zulip is best done by running