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
bc1849d7ff
matrix-docker-ansible-deploy/docs
History
Suguru Hirahara bc1849d7ff
Edit installing instructions (#3844) 
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all"

Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible.

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

* Edit installing instructions

- Move the anchor links to docs/just.md
- Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start"

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

* Update descriptions about installation

- Introduce the most conservative and stable raw ansible-playbook command.
- Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts.

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

* Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created

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-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-appservice-double-puppet.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-appservice-draupnir-for-all.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-backup-borg.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-buscarron.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-chatgpt.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-draupnir.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-go-neb.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-honoroit.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-matrix-registration-bot.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-matrix-reminder-bot.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-maubot.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bot-mjolnir.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-appservice-discord.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-appservice-irc.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-appservice-kakaotalk.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-appservice-slack.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-appservice-webhooks.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-beeper-linkedin.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-go-skype-bridge.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-heisenbridge.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-discord.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-facebook.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-googlechat.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-instagram.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-meta-instagram.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-meta-messenger.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-signal.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-slack.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-telegram.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-twitter.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-whatsapp.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mautrix-wsproxy.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mx-puppet-discord.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mx-puppet-groupme.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mx-puppet-instagram.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mx-puppet-steam.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-mx-puppet-twitter.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-postmoogle.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-bridge-wechat.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-cactus-comments.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-client-cinny.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-client-element-web.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-client-hydrogen.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-client-schildichat-web.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-dimension.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-dynamic-dns.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-email2matrix.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-ldap-auth.md Replace DOMAIN with example.com 2024-10-18 04:02:02 +09:00
configuring-playbook-ma1sd.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-matrix-authentication-service.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-matrix-corporal.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-matrix-ldap-registration-proxy.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-mautrix-bridges.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-postgres-backup.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-prometheus-grafana.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-prometheus-nginxlog.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-prometheus-postgres.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-rageshake.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-rest-auth.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-riot-web.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-sliding-sync-proxy.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
configuring-playbook-synapse-admin.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
importing-synapse-sqlite.md Edit line breaks in sentences and paragraphs 2024-10-23 01:13:23 +09:00
installing.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
just.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
maintenance-and-troubleshooting.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +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 Update triple backticks with syntax highlighting (#3832) 2024-11-28 11:33:56 +02:00
maintenance-synapse.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-upgrading-services.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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 Edit installing instructions (#3844) 2024-12-01 17:04:54 +02:00
README.md Update docs/README.md (#3822) 2024-11-25 18:18:11 +02:00
registering-users.md Edit installing instructions (#3844) 2024-12-01 17:04:54 +02: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