From 3e012889aa06cb5a0d68cd39e1ce2da6bd7f380c Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Tue, 20 Feb 2024 15:27:12 -0800 Subject: [PATCH] docs: Document restarts after changing zulip.conf. (cherry picked from commit 7d9c82cbea662ab63af9c728cc3f8c743a70e073) --- docs/production/system-configuration.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/production/system-configuration.md b/docs/production/system-configuration.md index ad2898c51d..d73bf54a29 100644 --- a/docs/production/system-configuration.md +++ b/docs/production/system-configuration.md @@ -1,9 +1,22 @@ ## System configuration -The file `/etc/zulip/zulip.conf` is used to configure properties of -the system and deployment; `/etc/zulip/settings.py` is used to -[configure the application itself](settings.md). The `zulip.conf` -sections and settings are described below. +The file `/etc/zulip/zulip.conf` is an [INI +format](https://en.wikipedia.org/wiki/INI_file) configuration file +used to configure properties of the system and deployment; +`/etc/zulip/settings.py` is used to [configure the application +itself](settings.md). The `zulip.conf` sections and settings are +described below. Changes to `zulip.conf` generally do not take effect +until you run `zulip-puppet-apply` as root: + +```console +# /home/zulip/deployments/current/scripts/zulip-puppet-apply +``` + +The `zulip-puppet-apply` command will display the configuration +changes it will make and prompt for you to confirm you'd like to make +those changes, before executing them (if you approve). + +### Truthy values When a setting refers to "set to true" or "set to false", the values `true` and `false` are canonical, but any of the following values will