Add a comment about systemd-python. (#9464)

This confused me for a while.
2021-02-23 13:42:36 +00:00 · 2021-02-23 13:42:36 +00:00 · 713145d3de
parent 65a9eb8994
commit 713145d3de
2 changed files with 4 additions and 0 deletions
--- a/changelog.d/9464.misc
+++ b/changelog.d/9464.misc
@ -0,0 +1 @@
+Add a comment about systemd-python.
--- a/synapse/python_dependencies.py
+++ b/synapse/python_dependencies.py
@ -106,6 +106,9 @@ CONDITIONAL_REQUIREMENTS = {
        "pysaml2>=4.5.0;python_version>='3.6'",
    ],
    "oidc": ["authlib>=0.14.0"],
+    # systemd-python is necessary for logging to the systemd journal via
+    # `systemd.journal.JournalHandler`, as is documented in
+    # `contrib/systemd/log_config.yaml`.
    "systemd": ["systemd-python>=231"],
    "url_preview": ["lxml>=3.5.0"],
    "sentry": ["sentry-sdk>=0.7.2"],