ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-22 10:49:35 +00:00
Code Issues Projects Releases Wiki Activity
04b32af0c1
matrix-docker-ansible-deploy/docs
History
Suguru Hirahara 04b32af0c1
Update docs for DNS settings etc. (#3936) 
* Update docs for DNS settings of the services which need its CNAME record by default

- Buscarron
- Go-NEB; fix a line on the instruction as well
- wsproxy
- Cinny
- Element Web
- Hydrogen
- SchildiChat Web
- Dimension
- Etherpad
- Jitsi
- ntfy
- Grafana
- rageshake
- Sygnal

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

* Update docs for DNS settings of the services which do not need its CNAME record by default

- matrix-alertmanager-receiver
- Honoroit
- maubot
- Heisenbridge
- Cactus Comments
- Matrix Authentication Service
- matrix-registration
- Sliding Sync proxy
- Synapse Admin
- synapse-usage-exporter

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

* Update docs for DNS settings: ma1sd

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

* Update docs for DNS settings: Email2Matrix

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

* Update docs for DNS settings: Postmoogle

Remove the table from configuring-dns.md altogether

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

* Update docs for Cinny and Dimension: adopt the common note

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

* Update docs/configuring-dns.md: add "Note" to the line on using Cloudflare DNS

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-15 09:22:00 +02:00
..
assets
alternative-architectures.md
ansible.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
configuring-captcha.md
configuring-dns.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-alertmanager-receiver.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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
configuring-playbook-bot-baibot.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bot-buscarron.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bot-go-neb.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-honoroit.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-matrix-registration-bot.md
configuring-playbook-bot-matrix-reminder-bot.md
configuring-playbook-bot-maubot.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-mjolnir.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-appservice-discord.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-appservice-irc.md
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
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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bridge-hookshot.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bridge-mx-puppet-discord.md
configuring-playbook-bridge-mx-puppet-groupme.md
configuring-playbook-bridge-mx-puppet-instagram.md
configuring-playbook-bridge-mx-puppet-skype.md
configuring-playbook-bridge-mx-puppet-slack.md
configuring-playbook-bridge-mx-puppet-steam.md
configuring-playbook-bridge-mx-puppet-twitter.md
configuring-playbook-bridge-postmoogle.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-cinny.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-element-web.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-hydrogen.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-schildichat-web.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-conduit.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-dendrite.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-dimension.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-dynamic-dns.md
configuring-playbook-email2matrix.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-email.md
configuring-playbook-etherpad.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-external-postgres.md
configuring-playbook-federation.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-jitsi.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-matrix-authentication-service.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-matrix-corporal.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md
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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-own-webserver.md
configuring-playbook-pantalaimon.md
configuring-playbook-postgres-backup.md
configuring-playbook-prometheus-grafana.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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
configuring-playbook-rageshake.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-rest-auth.md
configuring-playbook-riot-web.md
configuring-playbook-s3-goofys.md
configuring-playbook-s3.md
configuring-playbook-shared-secret-auth.md
configuring-playbook-sliding-sync-proxy.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-ssl-certificates.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-sygnal.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-synapse-admin.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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
configuring-playbook-synapse-s3-storage-provider.md Update docs/configuring-playbook-synapse-s3-storage-provider.md (#3932) 2025-01-12 13:19:08 +02:00
configuring-playbook-synapse-simple-antispam.md
configuring-playbook-synapse-usage-exporter.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-synapse.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-telemetry.md Update docs for homeserver implementations (Conduit, Dendrite, and Synapse) (#3926) 2025-01-11 09:49:53 +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
configuring-playbook-user-verification-service.md Tidy up docs/configuring-playbook-jitsi.md and another related file (#3934) 2025-01-13 08:42:55 +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
faq.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
getting-the-playbook.md
howto-server-delegation.md
howto-srv-server-delegation.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
importing-postgres.md
importing-synapse-media-store.md
importing-synapse-sqlite.md
installing.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
just.md
maintenance-and-troubleshooting.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
maintenance-checking-services.md
maintenance-migrating.md
maintenance-postgres.md
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
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
registering-users.md
self-building.md
uninstalling.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
updating-users-passwords.md

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