Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 106d99b

Browse files
Remove false warning about copying the log config to a homeserver.yaml (#11092)
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
1 parent 78d5896 commit 106d99b

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

changelog.d/11092.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify the the sample log config can be copied from the documentation without issue.

docs/usage/configuration/logging_sample_config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Below is a sample logging configuration file. This file can be tweaked to control how your
44
homeserver will output logs. A restart of the server is generally required to apply any
5-
changes made to this file.
5+
changes made to this file. The value of the `log_config` option in your homeserver
6+
config should be the path to this file.
67

7-
Note that the contents below are *not* intended to be copied and used as the basis for
8-
a real homeserver.yaml. Instead, if you are starting from scratch, please generate
9-
a fresh config using Synapse by following the instructions in
10-
[Installation](../../setup/installation.md).
8+
Note that a default logging configuration (shown below) is created automatically alongside
9+
the homeserver config when following the [installation instructions](../../setup/installation.md).
10+
It should be named `<SERVERNAME>.log.config` by default.
1111

1212
```yaml
1313
{{#include ../../sample_log_config.yaml}}
14-
```
14+
```

0 commit comments

Comments
 (0)