ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-10 13:23:50 +00:00
Code Issues Projects Releases Wiki Activity
638f53a889
matrix-docker-ansible-deploy/docs
History
Suguru Hirahara 638f53a889
Update docs for mautrix bridges (follow-up) (#3924) 
* Update docs/configuring-playbook-bridge-mautrix-telegram.md

- Add a link to the official documentation on authentication
- Create subsections in the section "Usage"
- Update the usage based on d33701428d/bridges/python/telegram/authentication.md

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

* Update docs/configuring-playbook-bridge-mautrix-twitter.md

- Remove a duplicated "optional" label
- Replace the instruction with a link to the official documentation on authentication

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

* Update docs/configuring-playbook-bridge-appservice-kakaotalk.md

- Adopt a common introduction
- Move the warning message down

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

* Update docs/configuring-playbook-bridge-mautrix-discord.md

As our instruction on usage has been outdated compared to the latest one (cf. d33701428d/bridges/go/discord/authentication.md), let alone confusing in the first place as our instruction on logging in and bridging have been mixed, this commit updates our instruction based on the latest official one.

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

* Update docs/configuring-playbook-bridge-mautrix-gmessages.md: add a link to the official documentation on authentication

Based on d33701428d/bridges/go/gmessages/authentication.md

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

* Update docs for mautrix-meta bridges: add links to the official documentation on authentication

Based on d33701428d/bridges/go/meta/authentication.md

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

* Update docs/configuring-playbook-bridge-mautrix-signal.md: add a link to the official documentation on authentication

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

* Update docs/configuring-playbook-bridge-mautrix-slack.md

Based on d33701428d/bridges/go/slack/authentication.md

The instruction has been obsolete since 25b4006035

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

* Update docs/configuring-playbook-bridge-mautrix-googlechat.md

Based on d33701428d/bridges/python/googlechat/authentication.md

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

* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add information about troubleshooting

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

* Update docs for mautrix bridges: add descriptions for each mautrix bridge about the bridges behavior after logging in

Based on d33701428d

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

* Update docs for mautrix bridges: add instruction for sending "help" to the bot to the common guide

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

* Update docs/configuring-playbook-bridge-mautrix-hangouts.md: adopt a common description about usage

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

* Update docs/configuring-playbook-bridge-mautrix-whatsapp.md

- Update the note about linked devices that they will be logged out if the phone is not used over two weeks: the note has been obsolete since 0860109d05
- Adopt a common description about usage

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

* Update docs for mautrix bridges: fix the internal anchor link

Regression by 4b2e066a61

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

* Update docs/configuring-playbook-bridge-mautrix-bridges.md: add a note about the official docs

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

* Update docs/configuring-playbook-bridge-go-skype-bridge.md: adopt the common description

As the bridge was created based on mautrix-whatsapp, this commit adopts the common descriptions for mautrix bridges and ones based on them such as matrix-appservice-kakaotalk and beeper-linkedin

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>
2025-01-10 09:36:27 +02:00
..
assets Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
alternative-architectures.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
ansible.md Upgrade devture/ansible (2.17.0-r0-2 -> 2.18.1-r0-0) 2024-12-08 12:10:44 +02:00
configuring-captcha.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-dns.md Edit docs/configuring-dns.md: clarify user ID shortness 2024-12-09 14:41:30 +09:00
configuring-playbook-alertmanager-receiver.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
configuring-playbook-appservice-double-puppet.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-appservice-draupnir-for-all.md Update docs for D4A, Draupnir, and Mjolnir (#3872) 2024-12-17 15:41:10 +02:00
configuring-playbook-backup-borg.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-base-domain-serving.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-bot-baibot.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-buscarron.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-chatgpt.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
configuring-playbook-bot-draupnir.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-bot-go-neb.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
configuring-playbook-bot-honoroit.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-matrix-registration-bot.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-matrix-reminder-bot.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-maubot.md Add customizations support to maubot 2024-12-28 10:24:42 +02:00
configuring-playbook-bot-mjolnir.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-bridge-appservice-discord.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-appservice-irc.md Use common expressions for using a bridge 2024-12-09 14:41:38 +09:00
configuring-playbook-bridge-appservice-kakaotalk.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-appservice-slack.md Use common expressions for using a bridge 2024-12-09 14:41:38 +09:00
configuring-playbook-bridge-appservice-webhooks.md Use common descriptions for mautrix bridges to improve consistency (#3914) 2025-01-09 09:28:29 +02:00
configuring-playbook-bridge-beeper-linkedin.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-go-skype-bridge.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-heisenbridge.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-bridge-hookshot.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-matrix-bridge-sms.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-bridge-mautrix-bridges.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-discord.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-facebook.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-googlechat.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-instagram.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-instagram.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-messenger.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-signal.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-slack.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-telegram.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-twitter.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-whatsapp.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-wsproxy.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mx-puppet-discord.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-groupme.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-instagram.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-skype.md Update documentation titles of deprecated or unmaintained services 2024-11-01 17:31:53 +09:00
configuring-playbook-bridge-mx-puppet-slack.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-steam.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-twitter.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-postmoogle.md Edit docs: consistent instructions to generate passphrases or secrets with pwgen 2024-12-22 17:53:14 +09:00
configuring-playbook-bridge-wechat.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-cactus-comments.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-client-cinny.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-client-element-web.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-client-hydrogen.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-client-schildichat-web.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-conduit.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-dendrite.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-dimension.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-dynamic-dns.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-email2matrix.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-email.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-playbook-etherpad.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-external-postgres.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-federation.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-jitsi.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-ldap-auth.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-ma1sd.md Update docs/configuring-playbook-user-verification-service.md, etc. (#3904) 2025-01-03 15:00:20 +02:00
configuring-playbook-matrix-authentication-service.md Edit user identifier examples: to @alice and @bob 2024-12-09 14:40:41 +09:00
configuring-playbook-matrix-corporal.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-matrix-ldap-registration-proxy.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-matrix-media-repo.md Update docs/configuring-playbook-matrix-media-repo.md: replace an external anchor link with an internal one 2024-12-24 01:53:09 +09:00
configuring-playbook-matrix-registration.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-nginx.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-ntfy.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-own-webserver.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-pantalaimon.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-postgres-backup.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-prometheus-grafana.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-prometheus-nginxlog.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-prometheus-postgres.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-rageshake.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-rest-auth.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-riot-web.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-s3-goofys.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-s3.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-shared-secret-auth.md Edit docs: consistent instructions to generate passphrases or secrets with pwgen 2024-12-22 17:53:14 +09:00
configuring-playbook-sliding-sync-proxy.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-ssl-certificates.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-sygnal.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-synapse-admin.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-synapse-auto-accept-invite.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-synapse-auto-compressor.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-synapse-s3-storage-provider.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-synapse-simple-antispam.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-synapse-usage-exporter.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-synapse.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-telemetry.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-traefik.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-turn.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-user-verification-service.md Update docs/configuring-playbook-user-verification-service.md: adopt the common section for controlling the logging level and minor changes (#3910) 2025-01-03 16:54:02 +02:00
configuring-playbook.md Update docs/configuring-playbook-mautrix-bridges.md (#3913) 2025-01-05 10:55:51 +02:00
configuring-well-known.md Update docs: Move "(optional)" on headers to the end of the line 2024-12-24 01:53:00 +09:00
container-images.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
faq.md Use common strings: "user ID" 2024-12-09 14:41:08 +09:00
getting-the-playbook.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
howto-server-delegation.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
howto-srv-server-delegation.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
importing-postgres.md Replace triple dots with horizontal ellipsis (U+2026) 2024-12-06 13:34:50 +09:00
importing-synapse-media-store.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
importing-synapse-sqlite.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
installing.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00
just.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
maintenance-and-troubleshooting.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
maintenance-checking-services.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-migrating.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-postgres.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
maintenance-synapse.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
maintenance-upgrading-services.md Edit docs/maintenance-upgrading-services.md: add details about the difference between install-all and setup-all in speed 2024-12-02 19:58:24 +09:00
obtaining-access-tokens.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
playbook-tags.md Add docs/just.md (#3811) 2024-11-23 11:52:48 +02:00
prerequisites.md Update docs/configuring-playbook-user-verification-service.md, etc. (#3904) 2025-01-03 15:00:20 +02:00
quick-start.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00
README.md Update README.md: remove a redundant whitespace character 2024-12-06 13:34:46 +09:00
registering-users.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00
self-building.md Add Pantalaimon support 2024-03-24 18:35:34 +02:00
uninstalling.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
updating-users-passwords.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00

README.md

Table of Contents

⬇️ Installaton guides

There are two installation guides available for beginners and advanced users.

🛠️ 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_store folder

👨‍🔧 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