0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-25 16:04:15 +01:00
Commit graph

37 commits

Author SHA1 Message Date
sando38
64dd8a9c6e
Include additional TURN server example into documentation ()
* 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 17:55:10 +00:00
Will Hunt
c913e440c0
Add monthly active users documentation ()
* Add monthly active users documentation

* changelog

* Tidy up notes

* more tidyup

* Rewrite 

* 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 14:48:43 +00:00
Brendan Abolivier
47822fd2e8
Merge branch 'master' into develop 2022-07-19 16:14:02 +02:00
Andrew Morgan
6faaf76a32
Remove 'anonymised' from the phone home stats documentation () 2022-07-19 12:38:29 +00:00
Patrick Cloke
1381563988
Inline URL preview documentation. ()
Inline URL preview documentation near the implementation.
2022-07-12 15:01:58 -04:00
Patrick Cloke
dcc7873700
Add information on how the Synapse team does reviews. () 2022-07-06 07:30:58 -04:00
Andrew Morgan
c0efc689cb
Add documentation for phone home stats () 2022-06-30 22:12:28 +01:00
Aaron Raimist
3ceaf1462d
Remove docs for Delete Group Admin API ()
This API no longer exists.

Signed-off-by: Aaron Raimist <aaron@raim.ist>
2022-06-27 11:15:25 +01:00
David Robertson
4579445cc5
Add missing TOC link to poetry cheat sheet ()
Missed by .
2022-06-10 15:47:49 +01:00
Sean Quah
3d8839c30c
Add documentation for cancellation of request processing ()
Signed-off-by: Sean Quah <seanq@matrix.org>
2022-05-18 17:56:23 +01:00
Shay
3c758d9808
Add a manual documenting config file options () 2022-04-18 11:32:30 -07:00
Brendan Abolivier
e4409301ba
Add a module callback to react to account data changes ()
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 11:22:48 +02:00
Patrick Cloke
9a0172d49f
Clean-up demo scripts & documentation ()
* 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 15:02:59 -05:00
Patrick Cloke
e4fdf459e2
Basic documentation for the release cycle. () 2022-02-10 13:15:10 +00:00
Richard van der Hoff
b3d155a749
Delete MSC1711_certificates_FAQ.md ()
This document isn't really relevant any more, and its existence is more confusing than helpful.
2022-02-04 11:27:00 +00:00
reivilibre
83a74d9350
Document the usage of refresh tokens. ()
Co-authored-by: David Robertson <davidr@element.io>
2021-12-08 15:31:17 +00:00
Dirk Klimpel
8b4b153c9e
Add admin API to get some information about federation status () 2021-12-06 16:59:50 +00:00
Shay
84dc50e160
Port wiki pages to documentation website ()
* 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 10:12:19 -08:00
Brendan Abolivier
153194c771
Link background update controller docs to summary () 2021-12-01 14:13:01 +00:00
Andrew Morgan
5f277ffe89
Add documentation page stubs for Single Sign-On, SAML and CAS pages () 2021-11-10 17:54:56 +00:00
Erik Johnston
4ee71b9637
Add some background update admin APIs ()
Fixes 
2021-11-08 16:08:02 +00:00
Azrenbeth
cdd308845b
Port the Password Auth Providers module interface to the new generic interface ()
Co-authored-by: Azrenbeth <7782548+Azrenbeth@users.noreply.github.com>
Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
2021-10-13 11:21:52 +00:00
Patrick Cloke
52913d56a5
Add documentation for experimental feature flags. () 2021-09-22 13:41:42 +00:00
Brendan Abolivier
03caba6577
Improve the modules doc ()
* 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 17:14:54 +00:00
Patrick Cloke
89ba834818
Use attrs internally for the URL preview code & add documentation. () 2021-09-07 13:10:34 +00:00
Callum Brown
947dbbdfd1
Implement MSC3231: Token authenticated registration ()
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 22:14:43 +01:00
Erik Johnston
78a70a2e0b Merge branch 'release-v1.41' into develop 2021-08-18 17:02:47 +01:00
Dirk Klimpel
430241a1e9
Remove deprecated Shutdown Room and Purge Room Admin API () 2021-08-17 21:19:13 +01:00
Brendan Abolivier
5639759980
Centralise the custom template directory ()
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 14:45:24 +02:00
Dirk Klimpel
834cdc3606
Add documentation for configuring a forward proxy. () 2021-08-05 07:20:05 -04:00
Eric Eastwood
2bae2c632f
Add developer documentation to explain room DAG concepts like outliers and state_groups () 2021-08-03 10:08:57 +00:00
Eric Eastwood
d518b05a86
Move dev/ docs to development/ () 2021-07-22 12:58:24 +02:00
Andrew Morgan
7f25d73859
Convert UPGRADE.rst to markdown ()
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 16:57:57 +01:00
Brendan Abolivier
1b3e398bea
Standardise the module interface ()
This PR adds a common configuration section for all modules (see docs). These modules are then loaded at startup by the homeserver. Modules register their hooks and web resources using the new `register_[...]_callbacks` and `register_web_resource` methods of the module API.
2021-06-18 12:15:52 +01:00
Michael Kaye
b8b282aa32
A guide to the request log lines format. ()
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 13:31:55 +01:00
Richard van der Hoff
c1b9922498
Support for database schema version ranges ()
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 14:45:53 +01:00
Andrew Morgan
fd9856e4a9
Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website () 2021-06-03 17:20:40 +01:00