diff options
| author | Travis Ralston <travisr@matrix.org> | 2021-10-20 05:48:15 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-20 11:48:15 +0000 |
| commit | 106d99b8cd7ac63d9578c05cfdf7b8e9def9906d (patch) | |
| tree | e24454055260ca253e7ece75d4e93dbe23043ec3 | |
| parent | Document the version of Synapse each module callback was introduced in (#11132) (diff) | |
| download | synapse-106d99b8cd7ac63d9578c05cfdf7b8e9def9906d.tar.xz | |
Remove false warning about copying the log config to a homeserver.yaml (#11092)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
| -rw-r--r-- | changelog.d/11092.doc | 1 | ||||
| -rw-r--r-- | docs/usage/configuration/logging_sample_config.md | 12 |
2 files changed, 7 insertions, 6 deletions
diff --git a/changelog.d/11092.doc b/changelog.d/11092.doc new file mode 100644 index 0000000000..916c2b3476 --- /dev/null +++ b/changelog.d/11092.doc @@ -0,0 +1 @@ +Clarify the the sample log config can be copied from the documentation without issue. diff --git a/docs/usage/configuration/logging_sample_config.md b/docs/usage/configuration/logging_sample_config.md index a673d487b8..499ab7cfe5 100644 --- a/docs/usage/configuration/logging_sample_config.md +++ b/docs/usage/configuration/logging_sample_config.md @@ -2,13 +2,13 @@ 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. +changes made to this file. The value of the `log_config` option in your homeserver +config should be the path to this file. -Note that the contents below are *not* intended to be copied and used as the basis for -a real homeserver.yaml. Instead, if you are starting from scratch, please generate -a fresh config using Synapse by following the instructions in -[Installation](../../setup/installation.md). +Note that a default logging configuration (shown below) is created automatically alongside +the homeserver config when following the [installation instructions](../../setup/installation.md). +It should be named `<SERVERNAME>.log.config` by default. ```yaml {{#include ../../sample_log_config.yaml}} -``` \ No newline at end of file +``` |