mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-01-28 19:04:57 +01:00
fea8df5ca2
* Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix sections title Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: merge configuration sections Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: small edits Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: remove a note abour Pantalaimon's unavailability Pantalaimon can be installed and it has become available for matrix-bot-draupnir and matrix-bot-mjolnir already. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: edit instruction of setting an alias to the management room Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-draupnir.md: remove 'c.' from the section title The section is not related to choosing E2EE support. Also: replace the instruction to go to the section with the anchor link. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create a section for common configs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: create "Extending the configuration" sections Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: create the "End-to-End Encryption support" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-mjolnir: adjust the section hierarchy Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: replace numbering This is a follow-up to e5ab17cafd62feb6e68e3234d434d69cbb383962. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: create "Prerequisites" section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: emphasize necessity of disabling rate limit Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: instruction for discharging rate limit on Synapse Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: edit the placeholder for matrix_bot_draupnir_pantalaimon_password and matrix_bot_mjolnir_pantalaimon_password Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update draupnir and mjolnir docs: add an anchor link to "Configuration with E2EE support" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-draupnir.md: move the "Abuse Reports" section above Also: use "pollReports: true" as an example for extending the configuration. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bot-draupnir.md and docs/configuring-playbook-bot-mjolnir.md: small edits Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: use a common expression cf. docs/configuring-playbook-alertmanager-receiver.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: integrate the description for installation by Draupnir into our description Check the original one: 120b37f3ea29101be3baf0856d5d23491db9309e Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-appservice-draupnir-for-all.md: fix a typo 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>
Table of Contents
⬇️ Installaton guides
There are two installation guides available for beginners and advanced users.
-
⚡ Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults".
-
Full installation guide (for advanced users): if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide.
🛠️ Configuration options
You can check useful documentation for configuring components here: Configuring the playbook
-
Administration - services that help you in administrating and monitoring your Matrix installation
-
Authentication and user-related - extend and modify how users are authenticated on your homeserver
-
Bots - bots provide various additional functionality to your installation
-
Bridges - bridges can be used to connect your Matrix installation with third-party communication networks
-
Clients - web clients for Matrix that you can host on your own domains
-
Core service adjustments - backbone of your Matrix system
-
File Storage - use alternative file storage to the default
media_storefolder
- Other specialized services - various services that don't fit any other categories
👨🔧 Maintenance
If your server and services experience issues, feel free to come to our support room and ask for help.
Other documentation pages
- ℹ️ FAQ - various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook