docs: Add a warning about restarting individual services.

restart-server is almost always the way to go, so we can be clearer
about it.
This commit is contained in:
Mateusz Mandera 2023-07-28 20:04:04 +02:00 committed by Tim Abbott
parent 732ad89f3d
commit b6cce494a8
1 changed files with 16 additions and 2 deletions

View File

@ -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