mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-27 11:28:31 +01:00
Code Issues Packages Projects Releases Wiki Activity
14a3a01f43
matrix-docker-ansible-deploy/docs
History
Suguru Hirahara 45352e76ce
Apply the common documentation style (#3840) 
* Update docs/configuring-playbook-bridge-appservice-webhooks.md: apply the common documentation style

Since the bridge has been deprecated, this change is simply intended to improve styling and format of the article in case it will be used as a template of another bridge in a future.

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

* Update docs/configuring-playbook-bridge-appservice-discord.md: apply the common documentation style

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

* Update docs/configuring-playbook-bridge-appservice-slack.md: apply the common documentation style

Also: move instruction to create Classic Slack application up as prerequisite

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

* Update docs/configuring-playbook-bridge-appservice-slack.md: emphasize the unavailability without a classic Slack application

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>
2024-11-29 17:52:28 +02:00
..
assets Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
alternative-architectures.md Determine matrix_architecture automatically 2022-11-22 09:22:56 +02:00
ansible.md Update devture/ansible reference (2.17.0-r0-1 -> 2.17.0-r0-2) 2024-11-29 09:08:09 +02:00
configuring-captcha.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-dns.md Remove links to "Quick start" from the breadcrumbs on full installation guide pages 2024-11-26 20:00:13 +09:00
configuring-playbook-alertmanager-receiver.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-appservice-double-puppet.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-appservice-draupnir-for-all.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-backup-borg.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-base-domain-serving.md Edit documentation related to server delegation (#3773) 2024-11-16 09:19:17 +02:00
configuring-playbook-bot-baibot.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bot-buscarron.md Fix capitalization: buscarron → Buscarron 2024-10-28 04:00:30 +09:00
configuring-playbook-bot-chatgpt.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bot-draupnir.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bot-go-neb.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bot-honoroit.md Replace !someRoom with !qporfwt 2024-10-21 21:47:52 +09:00
configuring-playbook-bot-matrix-registration-bot.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bot-matrix-reminder-bot.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-bot-maubot.md Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
configuring-playbook-bot-mjolnir.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bridge-appservice-discord.md Apply the common documentation style (#3840) 2024-11-29 17:52:28 +02:00
configuring-playbook-bridge-appservice-irc.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-appservice-kakaotalk.md Replace "Note" with "Warning" considering the significance 2024-11-29 12:24:29 +02:00
configuring-playbook-bridge-appservice-slack.md Apply the common documentation style (#3840) 2024-11-29 17:52:28 +02:00
configuring-playbook-bridge-appservice-webhooks.md Apply the common documentation style (#3840) 2024-11-29 17:52:28 +02:00
configuring-playbook-bridge-beeper-linkedin.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-go-skype-bridge.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-heisenbridge.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-hookshot.md Upgrade Hookshot (5.4.1 -> 6.0.1) 2024-11-29 17:51:11 +02:00
configuring-playbook-bridge-matrix-bridge-sms.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-mautrix-discord.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-facebook.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-googlechat.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-instagram.md Update documentation titles of deprecated or unmaintained services 2024-11-01 17:31:53 +09:00
configuring-playbook-bridge-mautrix-meta-instagram.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-meta-messenger.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-signal.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-slack.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-telegram.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-twitter.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-whatsapp.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +02:00
configuring-playbook-bridge-mautrix-wsproxy.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-mx-puppet-discord.md Update documentation regarding mx-puppet-discord 2024-10-28 11:53:16 +09:00
configuring-playbook-bridge-mx-puppet-groupme.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-mx-puppet-instagram.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +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 Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-bridge-mx-puppet-steam.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-mx-puppet-twitter.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-bridge-postmoogle.md Rename variables of Postmoogle to handle it as a bridge (#3698) 2024-10-31 10:33:46 +02:00
configuring-playbook-bridge-wechat.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-cactus-comments.md Update lines for installing instruction: add anchor link to "adjusting DNS records" header 2024-10-21 14:17:29 +09:00
configuring-playbook-client-cinny.md Mention publicly hosted services for Cinny, Element and synapse-admin 2024-11-09 21:18:39 +02:00
configuring-playbook-client-element-web.md Mention publicly hosted services for Cinny, Element and synapse-admin 2024-11-09 21:18:39 +02:00
configuring-playbook-client-hydrogen.md Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
configuring-playbook-client-schildichat-web.md Edit docs/configuring-playbook-client-schildichat-web.md: update the paragraph for warning 2024-11-17 15:50:21 +09:00
configuring-playbook-conduit.md Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
configuring-playbook-dendrite.md Update docs/configuring-playbook-conduit.md and docs/configuring-playbook-dendrite.md 2024-10-19 23:09:38 +09:00
configuring-playbook-dimension.md Replace "@user1" with "@alice" and "@user2" with "@bob" (#3833) 2024-11-28 13:53:11 +02:00
configuring-playbook-dynamic-dns.md Add ddclient to documentation 2024-11-01 02:58:14 +09:00
configuring-playbook-email2matrix.md Recategorize Postmoogle (#3696) 2024-10-28 16:27:42 +02:00
configuring-playbook-email.md Replace the warning emoji in text style (U+26A0 FE0E) to emoji style (U+26A0 FE0F) 2024-11-23 01:11:15 +09:00
configuring-playbook-etherpad.md Fix broken anchor links 2024-11-17 21:30:47 +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 triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-jitsi.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-ldap-auth.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-ma1sd.md Update docs/configuring-playbook-ma1sd.md (#3795) 2024-11-21 11:14:00 +02:00
configuring-playbook-matrix-authentication-service.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-matrix-corporal.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-playbook-matrix-media-repo.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-matrix-registration.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-mautrix-bridges.md Update documentation of setting up double puppeting with bridges (#3837) 2024-11-29 11:15:30 +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 Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-own-webserver.md Fix variable name typos (matrix_playbook_reverse_proxy_traefik_middleware_compession_* -> matrix_playbook_reverse_proxy_traefik_middleware_compression_*) 2024-11-21 12:23:01 +02:00
configuring-playbook-pantalaimon.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-postgres-backup.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-prometheus-grafana.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-prometheus-nginxlog.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-playbook-prometheus-postgres.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-rageshake.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-rest-auth.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-riot-web.md Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
configuring-playbook-s3-goofys.md Fix broken anchor links 2024-11-17 21:30:47 +09:00
configuring-playbook-s3.md Update docs/configuring-playbook-s3.md: replace the URL to matrix-media-repo 2024-11-02 18:16:29 +09:00
configuring-playbook-shared-secret-auth.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-sliding-sync-proxy.md Update docs/configuring-playbook-sliding-sync-proxy.md: Element X is no longer beta 2024-11-08 00:18:28 +09:00
configuring-playbook-ssl-certificates.md Clarify documentation about own ssl certificate setup 2024-10-18 21:28:50 +03:00
configuring-playbook-sygnal.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-synapse-admin.md Replace the warning emoji in text style (U+26A0 FE0E) to emoji style (U+26A0 FE0F) 2024-11-23 01:11:15 +09:00
configuring-playbook-synapse-auto-accept-invite.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-synapse-auto-compressor.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-synapse-s3-storage-provider.md Fix indentations of list items 2024-10-25 17:15:10 +09:00
configuring-playbook-synapse-simple-antispam.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-playbook-synapse-usage-exporter.md Synchronize document titles and links based on configuring-playbook.md 2024-10-26 21:28:31 +09:00
configuring-playbook-synapse.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-telemetry.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
configuring-playbook-traefik.md Fix the title of docs/configuring-playbook-traefik.md 2024-10-24 20:24:47 +09:00
configuring-playbook-turn.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook-user-verification-service.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
configuring-playbook.md Remove links to "Quick start" from the breadcrumbs on full installation guide pages 2024-11-26 20:00:13 +09:00
configuring-well-known.md Edit documentation related to server delegation (#3773) 2024-11-16 09:19:17 +02:00
container-images.md Fix broken anchor links 2024-11-17 21:30:47 +09:00
faq.md Update docs/faq.md: mention element-docker-demo project by Element 2024-11-29 00:55:24 +09:00
getting-the-playbook.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
howto-server-delegation.md Update docs/howto-server-delegation.md: related to removal of matrix-nginx-proxy 2024-11-16 17:36:46 +09:00
howto-srv-server-delegation.md Replace the warning emoji in text style (U+26A0 FE0E) to emoji style (U+26A0 FE0F) 2024-11-23 01:11:15 +09:00
importing-postgres.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
importing-synapse-media-store.md Fix anchor links and its title of documents related to Amazon S3 2024-11-01 16:37:41 +09:00
importing-synapse-sqlite.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
installing.md Replace "Note" with "Warning" considering the significance 2024-11-29 12:24:29 +02:00
just.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
maintenance-and-troubleshooting.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
maintenance-checking-services.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
maintenance-migrating.md Edit docs/maintenance-migrating.md (#3816) 2024-11-25 10:03:18 +02:00
maintenance-postgres.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
maintenance-synapse.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
maintenance-upgrading-services.md Update docs/maintenance-upgrading-services.md: replace the list with sections 2024-11-25 20:42:02 +09:00
obtaining-access-tokens.md Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
playbook-tags.md Add docs/just.md (#3811) 2024-11-23 11:52:48 +02:00
prerequisites.md Remove links to "Quick start" from the breadcrumbs on full installation guide pages 2024-11-26 20:00:13 +09:00
quick-start.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
README.md Update docs/README.md (#3822) 2024-11-25 18:18:11 +02:00
registering-users.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
self-building.md Add Pantalaimon support 2024-03-24 18:35:34 +02:00
uninstalling.md /usr/local/bin/matrix-remove-all -> /matrix/bin/remove-all 2022-11-27 09:47:02 +02:00
updating-users-passwords.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +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