Update docs for homeserver implementations (Conduit, Dendrite, and Synapse) (#3926)

* Update docs for Dendrite and Synapse: adopt the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse.md: move down the section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Dendrite and Synapse: remove redundant descriptions

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-conduit.md: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Conduit and Dendrite: replace "Notes" with "Warnings" plus the warning symbol

The information is important and should deserve clear attention.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse.md: reorganize sections for adjusting the playbook configuration

As the section for Synapse Admin is not related to adjusting the configuration, it was moved out of the it

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse.md: on Synapse Admin

Based on docs/configuring-playbook-bot-draupnir.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update URLs of the forked Dendrite repository

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Conduit and Dendrite: use the common descriptions for introductions

- Edit the instruction for adjusting the configuration

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse-admin.md: update the URL of the Dendrite documentation

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse.md: add the sections "Installing" and "Usage"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-conduit.md: copy an instruction from roles/custom/matrix-conduit/defaults/main.yml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs for Conduit and Dendrite: fix capitalization

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2025-01-11 16:49:53 +09:00
committed by GitHub
parent 4b9b6bf553
commit b017ffd853
5 changed files with 97 additions and 44 deletions

View File

@ -18,4 +18,4 @@ matrix_dendrite_report_stats: true # for dendrite
When enabled, your homeserver will regularly upload a few dozen statistics about your server. This data includes your homeserver's domain, the total number of users, the number of active users, the total number of rooms, and the number of messages sent per day on your homeserver.
See [Synapse's documentation](https://github.com/element-hq/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics) or [Dendrite's documentation](https://github.com/matrix-org/dendrite/blob/main/docs/FAQ.md#what-is-being-reported-when-enabling-phone-home-statistics) for the full list of statistics that are reported.
See [Synapse's documentation](https://github.com/element-hq/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics) or [Dendrite's documentation](https://github.com/element-hq/dendrite/blob/main/docs/FAQ.md#what-is-being-reported-when-enabling-phone-home-statistics) for the full list of statistics that are reported.