Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
synapse/docs/SUMMARY.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

118 lines
5.9 KiB
Markdown
Raw Permalink Normal View History

Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
# Summary
# Introduction
- [Welcome and Overview](welcome_and_overview.md)
# Setup
- [Installation](setup/installation.md)
- [Using Postgres](postgres.md)
- [Configuring a Reverse Proxy](reverse_proxy.md)
Add documentation for configuring a forward proxy. (#10443)
2021-08-05 05:20:05 -06:00
- [Configuring a Forward/Outbound Proxy](setup/forward_proxy.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Configuring a Turn Server](turn-howto.md)
Include additional TURN server example into documentation (#14293) * Include eturnal TURN server configuration example and moving specific configuration examples into sub folders. * Update docs/turn-howto.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Update docs/setup/turn/eturnal.md Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Fix TURN relaying public IP address hint * lint eturnal installation commands * Adjust synapse setup to link to existing documentation ..avoid redundant information. * remove redundant text * include alpine linux package link * Create 14293.doc * Update 14293.doc add missing dot * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/eturnal.md Co-authored-by: reivilibre <olivier@librepush.net> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update docs/setup/turn/coturn.md Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com> * Update eturnal.md to link to official documentation ... and to simplify some aspects * Adjust coturn to link to default prefix * Mention eturnalctl location * Update docs/turn-howto.md Co-authored-by: Saarko <sandomir@tutanotal.com> Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Co-authored-by: reivilibre <olivier@librepush.net> Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
2022-11-14 10:55:10 -07:00
- [coturn TURN server](setup/turn/coturn.md)
- [eturnal TURN server](setup/turn/eturnal.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Delegation](delegate.md)
# Upgrading
Convert UPGRADE.rst to markdown (#10166) This PR: * Converts UPGRADE.rst to markdown and moves the contents into the `docs/` directory. * Updates the contents of UPGRADE.rst to point to the website instead. * Updates links around the codebase that point to UPGRADE.rst. `pandoc` + some manual editing was used to convert from RST to md.
2021-06-23 09:57:57 -06:00
- [Upgrading between Synapse Versions](upgrade.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
# Usage
- [Federation](federate.md)
- [Configuration](usage/configuration/README.md)
Add new module API for adding custom fields to events `unsigned` section (#16549)
2023-10-27 03:04:08 -06:00
- [Configuration Manual](usage/configuration/config_documentation.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Homeserver Sample Config File](usage/configuration/homeserver_sample_config.md)
- [Logging Sample Config File](usage/configuration/logging_sample_config.md)
- [Structured Logging](structured_logging.md)
Centralise the custom template directory (#10596) Several configuration sections are using separate settings for custom template directories, which can be confusing. This PR adds a new top-level configuration for a custom template directory which is then used for every module. The only exception is the consent templates, since the consent template directory require a specific hierarchy, so it's probably better that it stays separate from everything else.
2021-08-17 06:45:24 -06:00
- [Templates](templates.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [User Authentication](usage/configuration/user_authentication/README.md)
Add documentation page stubs for Single Sign-On, SAML and CAS pages (#11298)
2021-11-10 10:54:56 -07:00
- [Single-Sign On](usage/configuration/user_authentication/single_sign_on/README.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [OpenID Connect](openid.md)
Add documentation page stubs for Single Sign-On, SAML and CAS pages (#11298)
2021-11-10 10:54:56 -07:00
- [SAML](usage/configuration/user_authentication/single_sign_on/saml.md)
- [CAS](usage/configuration/user_authentication/single_sign_on/cas.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [SSO Mapping Providers](sso_mapping_providers.md)
- [Password Auth Providers](password_auth_providers.md)
- [JSON Web Tokens](jwt.md)
Document the usage of refresh tokens. (#11427) Co-authored-by: David Robertson <davidr@element.io>
2021-12-08 08:31:17 -07:00
- [Refresh Tokens](usage/configuration/user_authentication/refresh_tokens.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Registration Captcha](CAPTCHA_SETUP.md)
- [Application Services](application_services.md)
- [Server Notices](server_notices.md)
- [Consent Tracking](consent_tracking.md)
- [User Directory](user_directory.md)
- [Message Retention Policies](message_retention_policies.md)
Improve the modules doc (#10758) * Split up the documentation in several files rather than one huge one * Add examples for each callback category * Other niceties like fixing https://github.com/matrix-org/synapse/issues/10632 * Add titles to callbacks so they're easier to find in the navigation panels and link to
2021-09-08 11:14:54 -06:00
- [Pluggable Modules](modules/index.md)
- [Writing a module](modules/writing_a_module.md)
- [Spam checker callbacks](modules/spam_checker_callbacks.md)
- [Third-party rules callbacks](modules/third_party_rules_callbacks.md)
- [Presence router callbacks](modules/presence_router_callbacks.md)
- [Account validity callbacks](modules/account_validity_callbacks.md)
Port the Password Auth Providers module interface to the new generic interface (#10548) Co-authored-by: Azrenbeth <7782548+Azrenbeth@users.noreply.github.com> Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
2021-10-13 05:21:52 -06:00
- [Password auth provider callbacks](modules/password_auth_provider_callbacks.md)
Link background update controller docs to summary (#11475)
2021-12-01 07:13:01 -07:00
- [Background update controller callbacks](modules/background_update_controller_callbacks.md)
Add a module callback to react to account data changes (#12327) Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2022-04-01 03:22:48 -06:00
- [Account data callbacks](modules/account_data_callbacks.md)
Add new module API for adding custom fields to events `unsigned` section (#16549)
2023-10-27 03:04:08 -06:00
- [Add extra fields to client events unsigned section callbacks](modules/add_extra_fields_to_client_events_unsigned.md)
Improve the modules doc (#10758) * Split up the documentation in several files rather than one huge one * Add examples for each callback category * Other niceties like fixing https://github.com/matrix-org/synapse/issues/10632 * Add titles to callbacks so they're easier to find in the navigation panels and link to
2021-09-08 11:14:54 -06:00
- [Porting a legacy module to the new interface](modules/porting_legacy_module.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Workers](workers.md)
- [Using `synctl` with Workers](synctl_workers.md)
- [Systemd](systemd-with-workers/README.md)
- [Administration](usage/administration/README.md)
- [Admin API](usage/administration/admin_api/README.md)
- [Account Validity](admin_api/account_validity.md)
Add some background update admin APIs (#11263) Fixes #11259
2021-11-08 09:08:02 -07:00
- [Background Updates](usage/administration/admin_api/background_updates.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Event Reports](admin_api/event_reports.md)
Fix up docs summary to include new experimental features admin API docs
2023-05-02 09:12:50 -06:00
- [Experimental Features](admin_api/experimental_features.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Media](admin_api/media_admin_api.md)
- [Purge History](admin_api/purge_history_api.md)
- [Register Users](admin_api/register_api.md)
Implement MSC3231: Token authenticated registration (#10142) Signed-off-by: Callum Brown <callum@calcuode.com> This is part of my GSoC project implementing [MSC3231](https://github.com/matrix-org/matrix-doc/pull/3231).
2021-08-21 15:14:43 -06:00
- [Registration Tokens](usage/administration/admin_api/registration_tokens.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Manipulate Room Membership](admin_api/room_membership.md)
- [Rooms](admin_api/rooms.md)
- [Server Notices](admin_api/server_notices.md)
- [Statistics](admin_api/statistics.md)
- [Users](admin_api/user_admin_api.md)
- [Server Version](admin_api/version_api.md)
Add admin API to get some information about federation status (#11407)
2021-12-06 09:59:50 -07:00
- [Federation](usage/administration/admin_api/federation.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Manhole](manhole.md)
- [Monitoring](metrics-howto.md)
Remove 'anonymised' from the phone home stats documentation (#13321)
2022-07-19 06:38:29 -06:00
- [Reporting Homeserver Usage Statistics](usage/administration/monitoring/reporting_homeserver_usage_statistics.md)
Add monthly active users documentation (#13617) * Add monthly active users documentation * changelog * Tidy up notes * more tidyup * Rewrite #1 * link back to mau docs * fix links * s/appservice|AS/application service * further review * a newline * Remove bit about shadow banned users. I think talking about them is confusing, and the current text doesn't imply they get any special treatment. * Update docs/usage/administration/monthly_active_users.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> * Update docs/usage/administration/monthly_active_users.md Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Brendan Abolivier <babolivier@matrix.org> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2022-09-01 08:48:43 -06:00
- [Monthly Active Users](usage/administration/monthly_active_users.md)
Port wiki pages to documentation website (#11402) * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * revert unintentional change to CHANGES.md * add link Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update CHANGES.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-12-01 11:12:19 -07:00
- [Understanding Synapse Through Grafana Graphs](usage/administration/understanding_synapse_through_grafana_graphs.md)
- [Useful SQL for Admins](usage/administration/useful_sql_for_admins.md)
- [Database Maintenance Tools](usage/administration/database_maintenance_tools.md)
Delete MSC1711_certificates_FAQ.md (#11907) This document isn't really relevant any more, and its existence is more confusing than helpful.
2022-02-04 04:27:00 -07:00
- [State Groups](usage/administration/state_groups.md)
A guide to the request log lines format. (#8436) This doc is short but a useful guide to what the request log lines mean. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Co-authored-by: Erik Johnston <erik@matrix.org> Co-authored-by: Daniele Sluijters <daenney@users.noreply.github.com>
2021-06-16 06:31:55 -06:00
- [Request log format](usage/administration/request_log.md)
Port wiki pages to documentation website (#11402) * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * revert unintentional change to CHANGES.md * add link Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update CHANGES.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-12-01 11:12:19 -07:00
- [Admin FAQ](usage/administration/admin_faq.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Scripts]()
# Development
- [Contributing Guide](development/contributing_guide.md)
- [Code Style](code_style.md)
Add information on how the Synapse team does reviews. (#13132)
2022-07-06 05:30:58 -06:00
- [Reviewing Code](development/reviews.md)
Basic documentation for the release cycle. (#11954)
2022-02-10 06:15:10 -07:00
- [Release Cycle](development/releases.md)
Move dev/ docs to development/ (#10453)
2021-07-22 04:58:24 -06:00
- [Git Usage](development/git.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Testing]()
Clean-up demo scripts & documentation (#12143) * Rewrites the demo documentation to be clearer, accurate, and moves it to our documentation tree. * Improvements to the demo scripts: * `clean.sh` now runs `stop.sh` first to avoid zombie processes. * Uses more modern Synapse configuration (and removes some obsolete configuration). * Consistently use the HTTP ports for server name, etc. * Remove the `demo/etc` directory and place everything into the `demo/808x` directories.
2022-03-08 13:02:59 -07:00
- [Demo scripts](development/demo.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [OpenTracing](opentracing.md)
Support for database schema version ranges (#9933) This is essentially an implementation of the proposal made at https://hackmd.io/@richvdh/BJYXQMQHO, though the details have ended up looking slightly different.
2021-06-11 07:45:53 -06:00
- [Database Schemas](development/database_schema.md)
Add documentation for experimental feature flags. (#10865)
2021-09-22 07:41:42 -06:00
- [Experimental features](development/experimental_features.md)
Add missing TOC link to poetry cheat sheet (#13022) Missed by #12475.
2022-06-10 08:47:49 -06:00
- [Dependency management](development/dependencies.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Synapse Architecture]()
Add documentation for cancellation of request processing (#12761) Signed-off-by: Sean Quah <seanq@matrix.org>
2022-05-18 10:56:23 -06:00
- [Cancellation](development/synapse_architecture/cancellation.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Log Contexts](log_contexts.md)
- [Replication](replication.md)
Add notes describing Synapse's streams (#16015) Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
2023-08-07 11:36:04 -06:00
- [Streams](development/synapse_architecture/streams.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [TCP Replication](tcp_replication.md)
Initial batch of notes on faster joins (#14677) Co-authored-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> Co-authored-by: Shay <hillerys@element.io>
2023-01-30 14:27:52 -07:00
- [Faster remote joins](development/synapse_architecture/faster_joins.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [Internal Documentation](development/internal_documentation/README.md)
- [Single Sign-On]()
Move dev/ docs to development/ (#10453)
2021-07-22 04:58:24 -06:00
- [SAML](development/saml.md)
- [CAS](development/cas.md)
Add developer documentation to explain room DAG concepts like `outliers` and `state_groups` (#10464)
2021-08-03 04:08:57 -06:00
- [Room DAG concepts](development/room-dag-concepts.md)
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086)
2021-06-03 10:20:40 -06:00
- [State Resolution]()
- [The Auth Chain Difference Algorithm](auth_chain_difference_algorithm.md)
- [Media Repository](media_repository.md)
- [Room and User Statistics](room_and_user_statistics.md)
- [Scripts]()
# Other
Support for database schema version ranges (#9933) This is essentially an implementation of the proposal made at https://hackmd.io/@richvdh/BJYXQMQHO, though the details have ended up looking slightly different.
2021-06-11 07:45:53 -06:00
- [Dependency Deprecation Policy](deprecation_policy.md)
Port wiki pages to documentation website (#11402) * move wiki pages to synapse/docs and add a few titles where necessary * update SUMMARY.md with added pages * add changelog * move incorrectly located newsfragment * update changelog number * snake case added files and update summary.md accordingly * update issue/pr links * update relative links to docs * update changelog to indicate that we moved wiki pages to the docs and state reasoning * revert unintentional change to CHANGES.md * add link Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update CHANGES.md Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2021-12-01 11:12:19 -07:00
- [Running Synapse on a Single-Board Computer](other/running_synapse_on_single_board_computers.md)