synapse/docs
Erik Johnston db131b6b22
Change the default log config to reduce disk I/O and storage (#8040)
* Change default log config to buffer by default.

This batches up writes to the filesystem, which is more efficient for
disk I/O. This means that it can take some time for logs to get written
to disk. Note that ERROR logs (and above) immediately flush the buffer.

This only effects new installs, as we only write the log config if
started with `--generate-config` (in the same way we do for generating
signing keys).

* Default to keeping last 4 days of logs.

This hopefully reduces the amount of logs kept for new servers. Keeping
the last 1GB of logs is likely overkill for new servers, but equally may
not be enough for busy ones.

Instead, we keep the last four days worth of logs, enough so that admins
can investigate any problems that happened over e.g. a long weekend.
2020-08-11 18:09:46 +01:00
..
admin_api Clarify that undoing a shutdown might not be possible (#8010) 2020-08-07 17:16:24 +01:00
dev Cleanups to the OpenID Connect integration (#7628) 2020-06-03 21:13:17 +01:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
sphinx Run Black. (#5482) 2019-06-20 19:32:02 +10:00
systemd-with-workers Fixup worker doc (again) (#8000) 2020-08-06 10:35:59 +01:00
.sample_config_header.yaml Various improvements to the docs (#7899) 2020-07-29 10:35:44 -04:00
ACME.md Update the dates for ACME v1 EOL 2020-07-22 16:18:40 +01:00
ancient_architecture_notes.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
application_services.md Add some explanation to application_services.md (#7091) 2020-04-27 15:03:09 +01:00
architecture.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
CAPTCHA_SETUP.md Modify doc to update Google ReCaptcha terms (#6257) 2019-10-30 12:30:20 +00:00
code_style.md Clarify list/set/dict/tuple comprehensions and enforce via flake8 (#6957) 2020-02-21 07:15:07 -05:00
consent_tracking.md Add config variables for enabling terms auth and the policy name (#4142) 2018-11-06 10:32:34 +00:00
delegate.md Incorporate review 2020-02-19 10:03:19 +00:00
federate.md Incorporate review 2020-02-19 10:03:19 +00:00
jwt.md Return the proper 403 Forbidden error during errors with JWT logins. (#7844) 2020-07-15 07:10:21 -04:00
log_contexts.md Clean up some LoggingContext stuff (#7120) 2020-03-24 14:45:33 +00:00
manhole.md
media_repository.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
message_retention_policies.md Rephrase 2020-02-12 15:39:40 +00:00
metrics-howto.md Fix typo in metrics docs (#7966) 2020-07-28 10:03:18 +01:00
MSC1711_certificates_FAQ.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
openid.md Add instructions for authing with Keycloak via OpenID (#7659) 2020-06-16 11:28:21 -04:00
opentracing.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
password_auth_providers.md Update the auth providers to be async. (#7935) 2020-07-23 15:45:39 -04:00
postgres.md Various improvements to the docs (#7899) 2020-07-29 10:35:44 -04:00
README.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
replication.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
reverse_proxy.md Add health check endpoint (#8048) 2020-08-07 14:21:24 +01:00
room_and_user_statistics.md Fix and refactor room and user stats (#5971) 2019-09-04 13:04:27 +01:00
sample_config.yaml Implement login blocking based on SAML attributes (#8052) 2020-08-11 16:08:10 +01:00
sample_log_config.yaml Change the default log config to reduce disk I/O and storage (#8040) 2020-08-11 18:09:46 +01:00
server_notices.md Add admin api for sending server_notices (#5121) 2019-05-02 11:59:16 +01:00
spam_checker.md Extend spam checker to allow for multiple modules (#7435) 2020-05-08 19:25:48 +01:00
sso_mapping_providers.md allow emails to be passed through SAML (#7385) 2020-05-27 17:40:08 +01:00
structured_logging.md Implement a structured logging output system. (#5680) 2019-08-28 21:18:53 +10:00
synctl_workers.md Update worker docs with recent enhancements (#7969) 2020-07-29 23:22:13 +01:00
tcp_replication.md Support any process writing to cache invalidation stream. (#7436) 2020-05-07 13:51:08 +01:00
turn-howto.md Minor clarifications to the TURN docs (#7533) 2020-05-20 11:04:34 +01:00
url_previews.md
user_directory.md Rename database classes to make some sense (#8033) 2020-08-05 21:38:57 +01:00
workers.md Fixup worker doc (again) (#8000) 2020-08-06 10:35:59 +01:00

Synapse Documentation

This directory contains documentation specific to the synapse homeserver.

All matrix-generic documentation now lives in its own project, located at matrix-org/matrix-doc

(Note: some items here may be moved to matrix-org/matrix-doc at some point in the future.)