summary refs log tree commit diff
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2023-01-19 11:58:17 +0000
committerGitHub <noreply@github.com>2023-01-19 11:58:17 +0000
commit2069231645169a7b3526fc742e76948c4363660a (patch)
tree76506e82838e0b7530053af48fde8e137d492bb9
parentWait for streams to catch up when processing HTTP replication. (#14820) (diff)
downloadsynapse-2069231645169a7b3526fc742e76948c4363660a.tar.xz
Update logging_sample_config.md (#14868)
You do not have to restart synapse to reload the log config.
-rw-r--r--changelog.d/14868.doc1
-rw-r--r--docs/usage/configuration/logging_sample_config.md8
2 files changed, 6 insertions, 3 deletions
diff --git a/changelog.d/14868.doc b/changelog.d/14868.doc
new file mode 100644
index 0000000000..b5ddff78a1
--- /dev/null
+++ b/changelog.d/14868.doc
@@ -0,0 +1 @@
+Minor corrections to the logging configuration documentation.
diff --git a/docs/usage/configuration/logging_sample_config.md b/docs/usage/configuration/logging_sample_config.md
index 499ab7cfe5..8956741997 100644
--- a/docs/usage/configuration/logging_sample_config.md
+++ b/docs/usage/configuration/logging_sample_config.md
@@ -1,9 +1,11 @@
 # Logging Sample Configuration File
 
 Below is a sample logging configuration file. This file can be tweaked to control how your
-homeserver will output logs. A restart of the server is generally required to apply any
-changes made to this file. The value of the `log_config` option in your homeserver
-config should be the path to this file.
+homeserver will output logs. The value of the `log_config` option in your homeserver config
+should be the path to this file.
+
+To apply changes made to this file, send Synapse a SIGHUP signal (or, if using `systemd`, run
+`systemctl reload` on the Synapse service).
 
 Note that a default logging configuration (shown below) is created automatically alongside
 the homeserver config when following the [installation instructions](../../setup/installation.md).