ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-03-07 22:30:44 +00:00
Code Issues Projects Releases Wiki Activity
22ea3b00d6
matrix-docker-ansible-deploy/docs
History
Suguru Hirahara 22ea3b00d6
Update docs for Element Web and SchildiChat Web: add the instruction to change the default country code to help to make the clients less British 
Note the order of the instructions is intended to align with that of configurations on main.yml files.

Also: replace the explanations with the one available at https://github.com/element-hq/element-web/blob/develop/docs/config.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-31 18:04:52 +09:00
..
assets Add "Web" to Element and SchildiChat web application () 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 Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
configuring-captcha.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-dns.md Update docs/configuring-dns.md: move down the section about DNS setting for optional server delegation 2025-01-16 02:50:53 +09:00
configuring-playbook-alertmanager-receiver.md Update files for the matrix-alertmanager-receiver: rename config.yml.j2 to config.yaml.j2 in order to improve consistency 2025-01-25 12:04:41 +09:00
configuring-playbook-appservice-double-puppet.md Update docs/configuring-playbook-appservice-double-puppet.md () 2025-01-17 17:32:56 +02:00
configuring-playbook-appservice-draupnir-for-all.md Replace old warnings with Github Markdown Warnings 2025-01-20 14:39:40 +01:00
configuring-playbook-backup-borg.md Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description 2025-01-22 01:38:26 +09: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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-bot-buscarron.md Update docs/configuring-playbook-bot-buscarron.md: add the common expression for linking to the documentation 2025-01-25 22:34:28 +09:00
configuring-playbook-bot-chatgpt.md Update docs/configuring-playbook-bot-chatgpt.md: add the common description and section "Troubleshooting" 2025-01-28 18:09:48 +09:00
configuring-playbook-bot-draupnir.md Update docs for Draupnir and Mjolnir: improve the instructions for running the curl command to disable rate limiting 2025-01-21 15:56:24 +09:00
configuring-playbook-bot-go-neb.md Update docs/configuring-playbook-bot-go-neb.md: add the common section "Troubleshooting" 2025-01-28 18:14:31 +09:00
configuring-playbook-bot-honoroit.md Update docs/configuring-playbook-bot-honoroit.md: add the common section "Troubleshooting" 2025-01-28 18:13:09 +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 Update docs/configuring-playbook-bot-matrix-reminder-bot.md: fix the service name 2025-01-28 18:33:29 +09:00
configuring-playbook-bot-maubot.md Update docs/configuring-playbook-bot-maubot.md: add the common section "Troubleshooting" 2025-01-30 01:17:41 +09:00
configuring-playbook-bot-mjolnir.md Update docs for Draupnir and Mjolnir: improve the instructions for running the curl command to disable rate limiting 2025-01-21 15:56:24 +09:00
configuring-playbook-bridge-appservice-discord.md Edit lines for vars.yml () 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-appservice-irc.md Update files for matrix-appservice-irc: adopt the common description for logging verbosity 2025-01-30 01:19:25 +09:00
configuring-playbook-bridge-appservice-kakaotalk.md Replace old warnings with Github Markdown Warnings 2025-01-20 14:39:40 +01:00
configuring-playbook-bridge-appservice-slack.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-bridge-appservice-webhooks.md Update files for matrix-appservice-webhooks: add the common section "Troubleshooting" 2025-01-30 01:20:42 +09:00
configuring-playbook-bridge-beeper-linkedin.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-go-skype-bridge.md Update files for go-skype-bridge: common comments for log levels 2025-01-30 02:07:36 +09:00
configuring-playbook-bridge-heisenbridge.md Update docs/configuring-playbook-bridge-heisenbridge.md: add the common section "Troubleshooting" 2025-01-30 01:21:58 +09:00
configuring-playbook-bridge-hookshot.md Update docs/configuring-playbook-bridge-hookshot.md: add a period 2025-01-25 18:24:40 +09:00
configuring-playbook-bridge-matrix-bridge-sms.md Update docs/configuring-playbook-bridge-matrix-bridge-sms.md: add the common section "Troubleshooting" 2025-01-30 02:16:36 +09:00
configuring-playbook-bridge-mautrix-bridges.md Edit lines for vars.yml () 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-mautrix-discord.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-facebook.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-googlechat.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-instagram.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-instagram.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-messenger.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-bridge-mautrix-signal.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-slack.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-telegram.md Edit lines for vars.yml () 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-mautrix-twitter.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-whatsapp.md Update docs for mautrix bridges (follow-up) () 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-wsproxy.md Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: move down the section "Extending the configuration" for consistency 2025-01-23 02:11:03 +09: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 Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
configuring-playbook-bridge-wechat.md Update files for matrix-bridge-wechat: sort the logging verbosity levels 2025-01-28 13:11:59 +09:00
configuring-playbook-cactus-comments.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-client-cinny.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-client-element-web.md Update docs for Element Web and SchildiChat Web: add the instruction to change the default country code to help to make the clients less British 2025-01-31 18:04:52 +09:00
configuring-playbook-client-hydrogen.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-client-schildichat-web.md Update docs for Element Web and SchildiChat Web: add the instruction to change the default country code to help to make the clients less British 2025-01-31 18:04:52 +09:00
configuring-playbook-conduit.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-conduwuit.md Change capitalization per author's preference: Conduwuit → conduwuit 2025-01-20 12:38:37 +09:00
configuring-playbook-dendrite.md Edit lines for vars.yml () 2025-01-12 15:31:19 +02:00
configuring-playbook-dimension.md Update docs/configuring-playbook-dimension.md: replace right arrows with actual ones 2025-01-24 23:01:10 +09:00
configuring-playbook-dynamic-dns.md Update docs/configuring-playbook-dynamic-dns.md: add the common section "Troubleshooting" 2025-01-30 02:03:08 +09:00
configuring-playbook-email2matrix.md Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
configuring-playbook-email.md Update docs/configuring-playbook-email.md: tidy up 2025-01-23 18:55:00 +09:00
configuring-playbook-etherpad.md Update docs/configuring-playbook-etherpad.md () 2025-01-17 11:34:58 +02:00
configuring-playbook-external-postgres.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-federation.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
configuring-playbook-jitsi.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-ldap-auth.md Update docs: misc edits for consistency () 2025-01-04 14:52:58 +02:00
configuring-playbook-ma1sd.md Update docs/configuring-playbook-ma1sd.md: fix configuration for increasing logging verbosity 2025-01-28 13:55:52 +09:00
configuring-playbook-matrix-authentication-service.md Update docs/configuring-playbook-matrix-authentication-service.md: add the common section "Troubleshooting" 2025-01-30 02:09:48 +09:00
configuring-playbook-matrix-corporal.md Update docs/configuring-playbook-matrix-corporal.md: add the common section "Troubleshooting" 2025-01-30 01:22:56 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: change placeholders 2025-01-28 15:52:39 +09:00
configuring-playbook-matrix-media-repo.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-matrix-registration.md Update docs/configuring-playbook-matrix-registration.md: add the common section "Troubleshooting" 2025-01-30 01:24:26 +09:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Update docs/configuring-playbook-ntfy.md: add the instruction for checking logs to the section "Troubleshooting" 2025-01-29 18:27:52 +09:00
configuring-playbook-own-webserver.md Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
configuring-playbook-pantalaimon.md Update docs/configuring-playbook-pantalaimon.md: add the common section "Troubleshooting" 2025-01-24 02:04:46 +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 Update docs for DNS settings etc. () 2025-01-15 09:22:00 +02:00
configuring-playbook-prometheus-nginxlog.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09: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 for DNS settings etc. () 2025-01-15 09:22:00 +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 Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +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 Update docs for DNS settings etc. () 2025-01-15 09:22:00 +02:00
configuring-playbook-ssl-certificates.md Edit lines for vars.yml () 2025-01-12 15:31:19 +02:00
configuring-playbook-sygnal.md Update files for Sygnal () 2025-01-18 09:15:04 +02:00
configuring-playbook-synapse-admin.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-synapse-auto-accept-invite.md Update docs: misc edits for consistency () 2025-01-04 14:52:58 +02:00
configuring-playbook-synapse-auto-compressor.md Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description 2025-01-22 01:38:26 +09:00
configuring-playbook-synapse-s3-storage-provider.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09: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 Update docs for DNS settings etc. () 2025-01-15 09:22:00 +02:00
configuring-playbook-synapse.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-telemetry.md Update docs for homeserver implementations (Conduit, Dendrite, and Synapse) () 2025-01-11 09:49:53 +02:00
configuring-playbook-traefik.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-turn.md Update files for coturn () 2025-01-17 10:19:17 +02:00
configuring-playbook-user-verification-service.md Update docs/configuring-playbook-user-verification-service.md () 2025-01-24 09:01:51 +02:00
configuring-playbook.md Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
configuring-well-known.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
container-images.md Update docs/container-images.md: remove definite articles from descriptions 2025-01-28 22:29:27 +09:00
faq.md Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
getting-the-playbook.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
howto-server-delegation.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
howto-srv-server-delegation.md Change capitalization per author's preference: Conduwuit → conduwuit 2025-01-20 12:38:37 +09:00
importing-postgres.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
installing.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
just.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
maintenance-and-troubleshooting.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
maintenance-migrating.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
maintenance-postgres.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
maintenance-synapse.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
playbook-tags.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
prerequisites.md Update files for coturn () 2025-01-17 10:19:17 +02:00
quick-start.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
README.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
registering-users.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
self-building.md
uninstalling.md Update docs: misc edits for consistency () 2025-01-04 14:52:58 +02:00
updating-users-passwords.md Update docs: minor changes () 2025-01-16 21:30:33 +02: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