synapse/docs
Travis Ralston b60bb28bbc
Add an admin API to get the current room state (#9168)
This could arguably replace the existing admin API for `/members`, however that is out of scope of this change.

This sort of endpoint is ideal for moderation use cases as well as other applications, such as needing to retrieve various bits of information about a room to perform a task (like syncing power levels between two places). This endpoint exposes nothing more than an admin would be able to access with a `select *` query on their database.
2021-02-02 11:16:29 +00:00
..
admin_api Add an admin API to get the current room state (#9168) 2021-02-02 11:16:29 +00:00
dev Refactor the CAS handler in prep for using the abstracted SSO code. (#8958) 2020-12-18 13:09:45 -05:00
privacy_policy_templates/en Update documentation and templates for new consent 2018-10-12 17:53:14 -06:00
systemd-with-workers Fix typo in docs/systemd-with-workers/README.md (#9035) 2021-01-07 15:31:01 +00: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
auth_chain_diff.dot Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_diff.dot.png Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
auth_chain_difference_algorithm.md Use a chain cover index to efficiently calculate auth chain difference (#8868) 2021-01-11 16:09:22 +00:00
CAPTCHA_SETUP.md Modify doc to update Google ReCaptcha terms (#6257) 2019-10-30 12:30:20 +00:00
code_style.md Remove docs/sphinx and related references (#8480) 2020-10-07 11:45:31 +01: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 Updated docs: Added note about missing 308 redirect support. (#8120) 2020-08-19 12:26:50 +01: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 Add note to manhole.md about bind_address when using with docker (#8526) 2020-10-14 15:28:59 +01:00
media_repository.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
message_retention_policies.md Update documentation on retention policies limits (#8529) 2020-10-14 15:00:49 +01:00
metrics-howto.md Improve documentation how to configure prometheus for workers (#8822) 2020-11-26 10:42:55 +00:00
MSC1711_certificates_FAQ.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
openid.md Put OIDC callback URI under /_synapse/client. (#9288) 2021-02-01 22:56:01 +00:00
opentracing.md (#5849) Convert rst to markdown (#6040) 2019-09-17 12:55:29 +01:00
password_auth_providers.md Fix typo in password_auth_providers doc 2020-12-01 10:34:52 +00:00
postgres.md Quote pip install with brackets to avoid shell interpretation. (#9151) 2021-01-18 11:12:20 -05: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 Increase default max_upload_size from 10M to 50M (#8502) 2020-10-09 16:58:23 +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 Put SAML callback URI under /_synapse/client. (#9289) 2021-02-02 09:43:50 +00:00
sample_log_config.yaml Support generating structured logs in addition to standard logs. (#8607) 2020-10-29 07:27:37 -04:00
server_notices.md Add admin api for sending server_notices (#5121) 2019-05-02 11:59:16 +01:00
spam_checker.md Allow spam-checker modules to be provide async methods. (#8890) 2020-12-11 14:05:15 -05:00
sso_mapping_providers.md Implement a username picker for synapse (#8942) 2020-12-18 14:19:46 +00:00
structured_logging.md Support generating structured logs in addition to standard logs. (#8607) 2020-10-29 07:27:37 -04:00
synctl_workers.md Update worker docs with recent enhancements (#7969) 2020-07-29 23:22:13 +01:00
tcp_replication.md Make event persisters periodically announce position over replication. (#8499) 2020-10-12 15:51:41 +01:00
turn-howto.md docs: Add link to Matrix VoIP tester for turn-howto (#9135) 2021-01-20 12:41:57 +00:00
url_previews.md move url_previews to MD as RST does my head in 2017-10-29 20:47:17 +00:00
user_directory.md Rename database classes to make some sense (#8033) 2020-08-05 21:38:57 +01:00
workers.md Put SAML callback URI under /_synapse/client. (#9289) 2021-02-02 09:43:50 +00: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.)