summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2019-12-31 10:47:29 +0000
committerRichard van der Hoff <richard@matrix.org>2019-12-31 10:47:29 +0000
commit0876a5b641419d8f85e706652046191e8b181d72 (patch)
tree8cf29eb0f384fec1bfe5d07643b76fc13d77cc34 /docs
parentMerge branch 'release-v1.7.2' into matrix-org-hotfixes (diff)
parent1.7.3 (diff)
downloadsynapse-0876a5b641419d8f85e706652046191e8b181d72.tar.xz
Merge branch 'release-v1.7.3' into matrix-org-hotfixes
Diffstat (limited to 'docs')
-rw-r--r--docs/sample_log_config.yaml43
-rw-r--r--docs/workers.md14
2 files changed, 56 insertions, 1 deletions
diff --git a/docs/sample_log_config.yaml b/docs/sample_log_config.yaml
new file mode 100644

index 0000000000..11e8f35f41 --- /dev/null +++ b/docs/sample_log_config.yaml
@@ -0,0 +1,43 @@ +# Example log config file for synapse. +# +# This is a YAML file containing a standard Python logging configuration +# dictionary. See [1] for details on the valid settings. +# +# [1]: https://docs.python.org/3.7/library/logging.config.html#configuration-dictionary-schema + +version: 1 + +formatters: + precise: + format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s' + +filters: + context: + (): synapse.logging.context.LoggingContextFilter + request: "" + +handlers: + file: + class: logging.handlers.RotatingFileHandler + formatter: precise + filename: /home/rav/work/synapse/homeserver.log + maxBytes: 104857600 + backupCount: 10 + filters: [context] + encoding: utf8 + console: + class: logging.StreamHandler + formatter: precise + filters: [context] + +loggers: + synapse.storage.SQL: + # beware: increasing this to DEBUG will make synapse log sensitive + # information such as access tokens. + level: INFO + +root: + level: INFO + handlers: [file, console] + +disable_existing_loggers: false diff --git a/docs/workers.md b/docs/workers.md
index 4bd60ba0a0..1b5d94f5eb 100644 --- a/docs/workers.md +++ b/docs/workers.md
@@ -196,7 +196,7 @@ Handles the media repository. It can handle all endpoints starting with: /_matrix/media/ -And the following regular expressions matching media-specific administration APIs: +... and the following regular expressions matching media-specific administration APIs: ^/_synapse/admin/v1/purge_media_cache$ ^/_synapse/admin/v1/room/.*/media$ @@ -206,6 +206,18 @@ You should also set `enable_media_repo: False` in the shared configuration file to stop the main synapse running background jobs related to managing the media repository. +In the `media_repository` worker configuration file, configure the http listener to +expose the `media` resource. For example: + +```yaml + worker_listeners: + - type: http + port: 8085 + resources: + - names: + - media +``` + Note this worker cannot be load-balanced: only one instance should be active. ### `synapse.app.client_reader`