mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2025-01-16 05:03:10 +01:00
4b2e066a61
* Update docs/configuring-playbook-mautrix-bridges.md: edit the section "extending the configuration" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-mautrix-bridges.md: edit section headers Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-mautrix-bridges.md: edit the section "Control the logging level" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-mautrix-bridges.md: replace examples for service name - Remove hangout, which has been shut down and whose role is soon to be removed from the playbook - Add a note about the Mautrix Meta bridge Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-mautrix-bridges.md: add descriptions to each section Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-mautrix-bridges.md: move the section "Set up Double Puppeting" to "Usage" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename docs/configuring-playbook-mautrix-bridges.md to docs/configuring-playbook-bridge-mautrix-bridges.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: edit an instruction Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add the manual step for setting up Double Puppetting Based on other documents for mautrix bridges like docs/configuring-playbook-bridge-mautrix-discord.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about bridges' incompatibility with Appservice Double Puppet Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: adopt the description on docs/configuring-playbook-appservice-double-puppet.md Make it clear that Double Puppetting with the other methods than the appservice one has been superseded. See: https://docs.mau.fi/bridges/general/double-puppeting.html#automatically Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add "recommended" label to the first method of setting up Double Puppeting Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add anchor links to the official documentation Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add descriptions about configuring bridge permissions Partially based on docs/configuring-playbook-bridge-mautrix-meta-instagram.md etc. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: add description about the relaybot Based on: - the official documentation: https://docs.mau.fi/bridges/general/relay-mode.html - docs/configuring-playbook-bridge-mautrix-whatsapp.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: remove a duplicated anchor link Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook.md: add an anchor link to configuring-playbook-bridge-mautrix-bridges.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: edit a sentence Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-bridge-mautrix-bridges.md: reflect the review See https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3913#discussion_r1903215741 Co-authored-by: Slavi Pantaleev <slavi@devture.com> 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> Co-authored-by: Slavi Pantaleev <slavi@devture.com>
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