summary refs log tree commit diff
path: root/docs/workers.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Remove `worker_replication_*` settings (#15491)Jason Little2023-05-111-12/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add master to the instance_map as part of Complement, have ReplicationEndpoint look at instance_map for master. * Fix typo in drive by. * Remove unnecessary worker_replication_* bits from unit tests and add master to instance_map(hopefully in the right place) * Several updates: 1. Switch from master to main for naming the main process in the instance_map. Add useful constants for easier adjustment of names in the future. 2. Add backwards compatibility for worker_replication_* to allow time to transition to new style. Make sure to prioritize declaring main directly on the instance_map. 3. Clean up old comments/commented out code. 4. Adjust unit tests to match with new code. 5. Adjust Complement setup infrastructure to only add main to the instance_map if workers are used and remove now unused options from the worker.yaml template. * Initial Docs upload * Changelog * Missed some commented out code that can go now * Remove TODO comment that no longer holds true. * Fix links in docs * More docs * Remove debug logging * Apply suggestions from code review Co-authored-by: reivilibre <olivier@librepush.net> * Apply suggestions from code review Co-authored-by: reivilibre <olivier@librepush.net> * Update version to latest, include completeish before/after examples in upgrade notes. * Fix up and docs too --------- Co-authored-by: reivilibre <olivier@librepush.net>
* Docs: Add Nginx loadbalancing example with sticky mxid for workers (#15411)Tatu Wikman2023-04-271-2/+64
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Docs: Add Nginx loadbalancing example with sticky mxid for workers Add example nginx configuration snippet that * does load balancing for workers * respects mxid part of the token * from both url parameter and auth header * and handles since parameter Thanks to @olmari for pushing me to write this and testing the configs Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> * Add changelog entry Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> * Update codeblock formatter Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Remove indirectly related nginx-config Signed-off-by: Sami Olmari <sami@olmari.fi> * Proper definition of action how to target username for worker Signed-off-by: Sami Olmari <sami@olmari.fi> * Change "nginx" to general "reverse proxy" as it's concept now. Signed-off-by: Sami Olmari <sami@olmari.fi> * Wording in better English Co-authored-by: Tatu Wikman <tatu.wikman@gmail.com> * rename changelog entry to have correct extension --------- Signed-off-by: Tatu Wikman <tatu.wikman@gmail.com> Signed-off-by: Sami Olmari <sami@olmari.fi> Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Co-authored-by: Sami Olmari <sami@olmari.fi> Co-authored-by: Sami Olmari <sami+github@olmari.fi>
* Load `/capabilities` endpoint on workers (#15436)Dirk Klimpel2023-04-141-0/+1
|
* Load `/directory/room/{roomAlias}` endpoint on workers (#15333)Dirk Klimpel2023-04-141-0/+1
| | | | | | | | | * Enable `directory` * move to worker store * newsfile * disable `ClientDirectoryListServer` and `ClientAppserviceDirectoryListServer` for workers
* Load `/password_policy` endpoint on workers. (#15331)Dirk Klimpel2023-03-271-0/+1
|
* Load `/register/available` endpoint on workers (#15268)Jason Little2023-03-171-0/+1
|
* Add a missing endpoint to the workers documentation. (#15223)Patrick Cloke2023-03-081-0/+1
|
* Add support for knocking to workers. (#15133)Dirk Klimpel2023-03-021-0/+1
|
* Allow use of the `/filter` Client-Server APIs on workers. (#15134)reivilibre2023-02-281-0/+1
|
* Document how to start Synapse with Poetry (#14892)ZAID BIN TARIQ2023-02-161-0/+11
| | | | | | | | | | | | | | | | * Add Start Synapse with Poetry * Create 14892.doc * Apply suggestions from code review Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com> * Update docs/workers.md --------- Co-authored-by: David Robertson <david.m.robertson1@gmail.com> Co-authored-by: Sean Quah <8349537+squahtx@users.noreply.github.com>
* Add missing worker settings to shared configuration (#14748)Dirk Klimpel2023-01-091-5/+36
| | | | | | | | | | | | | * Add missing worker settings to shared configuration * newsfile * update docs after review * more update for doc * This -> These Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
* Fix broken links in the Synapse documentation. (#14744)reivilibre2023-01-051-2/+2
| | | | | | | | | | | | | | | | | * Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
* Update worker docs to update preferred settings for pusher and ↵realtyem2022-12-021-0/+8
| | | | | | | | | | | | | | | | | | | | | federation_sender (#14493) * Fix one typo on line 3700(and apparently do something to other lines, no idea) * Update config_documentation.md with more information about how federation_senders and pushers settings can be handled. Specifically, that the instance map style of config does not require the special other variables that enable and disable functionality and that a single worker CAN be added to the map not only just two or more. * Extra line here for consistency and appearance. * Add link to sygnal repo. * Add deprecation notice to workers.md and point to the newer alternative method of defining this functionality. * Changelog * Correct version number of Synapse the deprecation is happening in. * Update quiet deprecation with simple notice and suggestion.
* Move MSC3030 `/timestamp_to_event` endpoint to stable v1 location (#14471)Eric Eastwood2022-11-281-0/+2
| | | | | | | | Fix https://github.com/matrix-org/synapse/issues/14390 - Client API: `/_matrix/client/unstable/org.matrix.msc3030/rooms/<roomID>/timestamp_to_event?ts=<timestamp>&dir=<direction>` -> `/_matrix/client/v1/rooms/<roomID>/timestamp_to_event?ts=<timestamp>&dir=<direction>` - Federation API: `/_matrix/federation/unstable/org.matrix.msc3030/timestamp_to_event/<roomID>?ts=<timestamp>&dir=<direction>` -> `/_matrix/federation/v1/timestamp_to_event/<roomID>?ts=<timestamp>&dir=<direction>` Complement test changes: https://github.com/matrix-org/complement/pull/559
* Fix version that `worker_main_http_uri` is redundant from (#14476)David Robertson2022-11-171-2/+2
| | | | | * Fix version that `worker_main_http_uri` is redundant from * Changelog
* Remove need for `worker_main_http_uri` setting to use /keys/upload. (#14400)realtyem2022-11-161-4/+3
|
* Add example on how to load balance /sync requests (#14297)aceArt-GmbH2022-11-071-3/+5
| | | | | Signed-off-by: lukas <lukas.walter@aceart.de> Signed-off-by: lukas <lukas.walter@aceart.de>
* Add workers settings to configuration manual (#14086)Dirk Klimpel2022-10-271-32/+68
| | | | | | | | | | | | | | | | | | | | * Add workers settings to configuration manual * Update `pusher_instances` * update url to python logger * update headlines * update links after headline change * remove link from `daemon process` There is no docs in Synapse for this * extend example for `federation_sender_instances` and `pusher_instances` * more infos about stream writers * add link to DAG * update `pusher_instances` * update `worker_listeners` * update `stream_writers` * Update `worker_name` Co-authored-by: David Robertson <davidr@element.io>
* Stabilize the threads API. (#14175)Patrick Cloke2022-10-141-0/+1
| | | | | | | Stabilize the threads API (MSC3856) by supporting (only) the v1 path for the endpoint. This also marks the API as safe for workers since it is a read-only API.
* Mark /relations endpoint as usable on workers. (#14028)Patrick Cloke2022-10-121-0/+1
| | | Co-authored-by: Eric Eastwood <erice@element.io>
* Add sample worker files for `pusher` and `federation_sender` (#14077)Dirk Klimpel2022-10-071-0/+12
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Add some cross references to worker documentation (#13974)Dirk Klimpel2022-09-301-15/+13
| | | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Remove configuration options for direct TCP replication. (#13647)Patrick Cloke2022-09-061-17/+5
| | | Removes the ability to configure legacy direct TCP replication. Workers now require Redis to run.
* Remove documentation of legacy `frontend_proxy` worker app (#13645)Richard van der Hoff2022-08-301-41/+20
| | | | | This has been the same as a generic_worker since #6964, so let's get rid of it. Fixes #3717
* Clarify documentation about replication traffic. (#13656)Patrick Cloke2022-08-301-1/+4
| | | | It can be authenticated with the worker_replication_secret setting, but is always unencrypted.
* Remove remaining bits of groups code. (#12936)Patrick Cloke2022-06-011-6/+0
| | | | | | * Update worker docs to remove group endpoints. * Removes an unused parameter to `ApplicationService`. * Break dependency between media repo and groups. * Avoid copying `m.room.related_groups` state events during room upgrades.
* Remove unstable APIs for /hierarchy. (#12851)Patrick Cloke2022-05-261-3/+3
| | | | Removes the unstable endpoint as well as a duplicated field which was modified during stabilization.
* Add the `batch_send` endpoint to generic workers (#12868)Nick Mills-Barrett2022-05-251-0/+1
|
* Add the `/account/whoami` endpoint to generic workers (#12866)Nick Mills-Barrett2022-05-251-0/+1
|
* Fix incorrect worker-allowed path in documentation (#12867)Nick Mills-Barrett2022-05-251-3/+0
|
* Fix typos in documentation (#12863)Dirk Klimpel2022-05-251-1/+1
|
* Add missing user directory search endpoint to the generic worker ↵Sami Olmari2022-05-191-0/+10
| | | | | | documentation (#12773) Signed-off-by: Sami Olmari <sami@olmari.fi>
* Add the `update_user_directory_from_worker` configuration option ↵reivilibre2022-05-101-3/+23
| | | | | (superseding `update_user_directory`) to allow a generic worker to be designated as the worker to update the user directory. (#12654) Co-authored-by: Shay <hillerys@element.io>
* Add the `notify_appservices_from_worker` configuration option (superseding ↵reivilibre2022-05-061-0/+20
| | | | `notify_appservices`) to allow a generic worker to be designated as the worker to send traffic to Application Services. (#12452)
* Add some example configurations for worker (#12492)Dirk Klimpel2022-04-251-23/+22
| | | Signed-off-by: Dirk Klimpel <dirk@klimpel.org>
* Update documentation to reflect that `run_background_tasks_on` is no longer ↵reivilibre2022-04-141-4/+4
| | | | | | | | | | | experimental. (#12451) * Background workers aren't experimental anymore * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Stream writers aren't experimental either
* Replace `federation_reader` with `generic_worker` in docs (#12457)Dirk Klimpel2022-04-141-6/+4
|
* Update broken link in `workers.md` (#12369)Shay2022-04-041-1/+1
|
* Remove mutual_rooms `update_user_directory` check, and add extra ↵Jonathan de Jong2022-03-231-1/+10
| | | | | documentation (#12038) Resolves #10339
* Sync more worker regexes in the documentation. (#12243)Patrick Cloke2022-03-181-16/+14
|
* Document that most streams can only have a single writer. (#12196)~creme2022-03-101-14/+17
| | | | This includes the `typing`, `to_device`, `account_data`, `receipts`, and `presence` streams (really anything except the `events` stream).
* Remove the unstable `/spaces` endpoint. (#12073)Patrick Cloke2022-02-281-2/+0
| | | | | | | | ...and various code supporting it. The /spaces endpoint was from an old version of MSC2946 and included both a Client-Server and Server-Server API. Note that the unstable /hierarchy endpoint (from the final version of MSC2946) is not yet removed.
* Add documentation for missing worker types. (#11599)Patrick Cloke2022-02-231-14/+76
| | | And clean-up the endpoints which should be routed to workers.
* Stabilise MSC3231 (Token Based Registration) (#11867)Jonathan de Jong2022-02-041-1/+1
|
* Support the stable /hierarchy endpoint from MSC2946 (#11329)Patrick Cloke2021-11-291-2/+2
| | | | | | This also makes additional updates where the implementation had drifted from the approved MSC. Unstable endpoints will be removed at a later data.
* Add support for `/_matrix/media/v3` APIs (#11371)Aaron R2021-11-171-35/+35
| | | | | | | | | | | | | * Add support for `/_matrix/media/v3` APIs Signed-off-by: Aaron Raimist <aaron@raim.ist> * Update `workers.md` to use v3 client and media APIs Signed-off-by: Aaron Raimist <aaron@raim.ist> * Add changelog Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Improve code formatting and fix a few typos in docs (#11221)Sumner Evans2021-11-011-8/+10
| | | | | | * Labeled a lot more code blocks with the appropriate type * Fixed a couple of minor typos (missing/extraneous commas) Signed-off-by: Sumner Evans <me@sumnerevans.com>
* Document that /spaces & /hierarchy can be routed to workers. (#10648)Patrick Cloke2021-09-081-0/+5
| | | Also refactors some of the registration of endpoints on workers.
* Implement MSC3231: Token authenticated registration (#10142)Callum Brown2021-08-211-0/+1
| | | | | 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).
* Mount /_synapse/admin/v1/users/{userId}/media admin API on media workers ↵Andrew Morgan2021-08-181-1/+3
| | | | | only (#10628) Co-authored-by: Patrick Cloke <patrickc@matrix.org>
* Allow /createRoom to be run on workers (#10564)Andrew Morgan2021-08-171-0/+1
| | | Fixes https://github.com/matrix-org/synapse/issues/7867
* Docs: Use something other than the document name to describe a page (#10399)Andrew Morgan2021-07-151-3/+3
| | | | | Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website. This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
* Fix broken links in documentation (#10180)Dirk Klimpel2021-06-161-1/+1
| | | | | * Fix broken links in documentation * newsfile
* Move some more endpoints off master (#10084)Erik Johnston2021-05-271-0/+3
|
* docs: fallback/web endpoint does not appear to be mounted on workers (#9679)Ben Banfield-Zanin2021-03-241-2/+1
|
* Revert "Update workers.md"Richard van der Hoff2021-02-181-1/+1
| | | | This reverts commit a8878960c0139f80bbb6f84bd0f0cb7352429c5b.
* Update workers.mdRichard van der Hoff2021-02-171-1/+2
|
* Update workers.mdRichard van der Hoff2021-02-171-1/+1
| | | tiny typo in sso paths
* Document that pusher instances are shardable (#9407)Erik Johnston2021-02-161-1/+9
|
* Put SAML callback URI under /_synapse/client. (#9289)Richard van der Hoff2021-02-021-1/+1
|
* Put OIDC callback URI under /_synapse/client. (#9288)Richard van der Hoff2021-02-011-1/+1
|
* Merge branch 'social_login' into developRichard van der Hoff2021-02-011-0/+1
|\
| * Collect terms consent from the user during SSO registration (#9276)Richard van der Hoff2021-02-011-0/+1
| |
* | Merge branch 'social_login' into developRichard van der Hoff2021-02-011-8/+10
|\|
| * Fix SSO on workers (#9271)Richard van der Hoff2021-02-011-8/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes #8966. * Factor out build_synapse_client_resource_tree Start a function which will mount resources common to all workers. * Move sso init into build_synapse_client_resource_tree ... so that we don't have to do it for each worker * Fix SSO-login-via-a-worker Expose the SSO login endpoints on workers, like the documentation says. * Update workers config for new endpoints Add documentation for endpoints recently added (#8942, #9017, #9262) * remove submit_token from workers endpoints list this *doesn't* work on workers (yet). * changelog * Add a comment about the odd path for SAML2Resource
* | Add a note to changelog about redis usage (#9227)Erik Johnston2021-01-271-1/+4
|/
* Quote pip install with brackets to avoid shell interpretation. (#9151)Patrick Cloke2021-01-181-1/+1
|
* link to the scalability blog post from workers.mdMatthew Hodgson2021-01-181-0/+3
|
* Register the /devices endpoint on workers. (#9092)Patrick Cloke2021-01-131-0/+1
|
* Allow redacting events on workers (#8994)Patrick Cloke2020-12-291-0/+1
| | | Adds the redacts endpoint to workers that have the client listener.
* Add authentication to replication endpoints. (#8853)Patrick Cloke2020-12-041-1/+5
| | | | Authentication is done by checking a shared secret provided in the Synapse configuration file.
* Notes on SSO logins and media_repository worker (#8701)Marcus Schopen2020-11-061-0/+5
| | | | | | | If SSO login is used (e.g. SAML) in a multi worker setup, it should be mentioned that currently all SAML logins must run on the same worker, see https://github.com/matrix-org/synapse/issues/7530 Also, if you are using different ports (for example 443 and 8448) in a reverse proxy for client and federation, the path `/_matrix/media` on the client and federation port must point to the listener of the `media_repository` worker, otherwise you'll get a 404 on the federation port for the path `/_matrix/media`, if a remote server is trying to get the media object on federation port, see https://github.com/matrix-org/synapse/issues/8695
* Document how to set up multiple event persisters (#8706)Erik Johnston2020-11-031-0/+12
|
* grammarMatthew Hodgson2020-11-021-1/+1
|
* Fix typo in workers docAndrew Morgan2020-11-021-1/+1
|
* Allow background tasks to be run on a separate worker. (#8369)Patrick Cloke2020-10-021-0/+17
|
* Allow additional SSO properties to be passed to the client (#8413)Patrick Cloke2020-09-301-0/+16
|
* Merge tag 'v1.20.0rc3' into developPatrick Cloke2020-09-111-1/+0
|\ | | | | | | | | | | | | | | | | | | Synapse 1.20.0rc3 (2020-09-11) ============================== Bugfixes -------- - Fix a bug introduced in v1.20.0rc1 where the wrong exception was raised when invalid JSON data is encountered. ([\#8291](https://github.com/matrix-org/synapse/issues/8291))
| * Remove shared rooms info from upgrade/workers doc as it's still experimental ↵Andrew Morgan2020-09-101-1/+0
| | | | | | | | (#8290)
* | Add /_synapse/client to the reverse proxy docs (#8227)Andrew Morgan2020-09-101-0/+1
|/ | | This PR adds a information about forwarding `/_synapse/client` endpoints through your reverse proxy. The first of these endpoints are introduced in https://github.com/matrix-org/synapse/pull/8004.
* Add /user/{user_id}/shared_rooms/ api (#7785)Will Hunt2020-09-021-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add shared_rooms api * Add changelog * Add . * Wrap response in {"rooms": } * linting * Add unstable_features key * Remove options from isort that aren't part of 5.x `-y` and `-rc` are now default behaviour and no longer exist. `dont-skip` is no longer required https://timothycrosley.github.io/isort/CHANGELOG/#500-penny-july-4-2020 * Update imports to make isort happy * Add changelog * Update tox.ini file with correct invocation * fix linting again for isort * Vendor prefix unstable API * Fix to match spec * import Codes * import Codes * Use FORBIDDEN * Update changelog.d/7785.feature Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Implement get_shared_rooms_for_users * a comma * trailing whitespace * Handle the easy feedback * Switch to using runInteraction * Add tests * Feedback * Seperate unstable endpoint from v2 * Add upgrade node * a line * Fix style by adding a blank line at EOF. * Update synapse/storage/databases/main/user_directory.py Co-authored-by: Tulir Asokan <tulir@maunium.net> * Update synapse/storage/databases/main/user_directory.py Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Update UPGRADE.rst Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Fix UPGRADE/CHANGELOG unstable paths unstable unstable unstable Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Tulir Asokan <tulir@maunium.net> Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com> Co-authored-by: Tulir Asokan <tulir@maunium.net>
* Fixup worker doc (again) (#8000)Erik Johnston2020-08-061-13/+41
|
* Update workers docs (#7990)Stuart Mumford2020-07-301-25/+34
|
* Fix typo in docs/workers.md (#7992)Erik Johnston2020-07-301-1/+1
|
* Update worker docs with recent enhancements (#7969)Erik Johnston2020-07-291-213/+246
|
* Support running multiple media repos. (#7706)Erik Johnston2020-06-171-1/+6
| | | | | This requires a new config option to specify which media repo should be responsible for running background jobs to e.g. clear out expired URL preview caches.
* Documentation on setting up redis (#7446)Neil Johnson2020-05-111-60/+107
|
* Merge branch 'release-v1.12.4' into developRichard van der Hoff2020-04-221-0/+2
|\
| * Support GET account_data requests on a worker (#7311)Richard van der Hoff2020-04-211-0/+2
| |
* | Make systemd-with-workers doc official (#7234)Richard van der Hoff2020-04-081-15/+33
|/ | | | Simplify and update this documentation, and make it part of the core dist.
* Update routing of fallback auth in the worker docs. (#7048)Patrick Cloke2020-03-091-0/+1
|
* Fix worker docs to point `/publicised_groups` API correctly. (#6938)Erik Johnston2020-02-181-3/+4
|
* Add support for putting fed user query API on workers (#6873)Erik Johnston2020-02-071-0/+1
|
* Allow moving group read APIs to workers (#6866)Erik Johnston2020-02-071-0/+8
|
* Fix federation_reader listeners doc as per PR reviewJason Robinson2020-01-271-2/+12
| | | | Signed-off-by: Jason Robinson <jasonr@matrix.org>
* Clarifications to the workers documentationJason Robinson2020-01-241-0/+7
| | | | | | | | | * Add note that user_dir requires disabling user dir updates from the main synapse process. * Add note that federation_reader should have the federation listener resource. Signed-off-by: Jason Robinson <jasonr@matrix.org>
* Quarantine media by ID or user ID (#6681)Andrew Morgan2020-01-131-1/+3
|
* Document more supported endpoints for workers (#6698)Richard van der Hoff2020-01-131-0/+4
|
* Update workers.md to make media_repository work (again) (#6519)Mark Nowiasz2019-12-111-1/+13
|
* (#5849) Convert rst to markdown (#6040)dstipp2019-09-171-0/+284
Converting some of the rst documentation to markdown. Attempted to preserve whitespace and line breaks to minimize cosmetic change.
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-09-20 17:33:42 +0000