mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-12-22 12:35:51 +00:00
20c2aade3e
* Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command
This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add comments about using setup-all instead of install-all
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags
It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does
Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it
Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just"
This commit also fixes list item capitalization and punctuation.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add notes bullet lists
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "run the installation command" with "run the playbook with tags"
Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add notes about changing passwords of users specified on vars.yml
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove redundant blank lines
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage
Such a kind of direction is not used on other documentation, so it should be fine to just remove it.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/importing-synapse-media-store.md: code block for ansible-playbook
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>
|
||
|---|---|---|
| .. | ||
| assets | ||
| alternative-architectures.md | ||
| ansible.md | ||
| configuring-captcha.md | ||
| configuring-dns.md | ||
| configuring-playbook-alertmanager-receiver.md | ||
| configuring-playbook-appservice-double-puppet.md | ||
| configuring-playbook-appservice-draupnir-for-all.md | ||
| configuring-playbook-backup-borg.md | ||
| configuring-playbook-base-domain-serving.md | ||
| configuring-playbook-bot-baibot.md | ||
| configuring-playbook-bot-buscarron.md | ||
| configuring-playbook-bot-chatgpt.md | ||
| configuring-playbook-bot-draupnir.md | ||
| configuring-playbook-bot-go-neb.md | ||
| configuring-playbook-bot-honoroit.md | ||
| configuring-playbook-bot-matrix-registration-bot.md | ||
| configuring-playbook-bot-matrix-reminder-bot.md | ||
| configuring-playbook-bot-maubot.md | ||
| configuring-playbook-bot-mjolnir.md | ||
| configuring-playbook-bridge-appservice-discord.md | ||
| configuring-playbook-bridge-appservice-irc.md | ||
| configuring-playbook-bridge-appservice-kakaotalk.md | ||
| configuring-playbook-bridge-appservice-slack.md | ||
| configuring-playbook-bridge-appservice-webhooks.md | ||
| configuring-playbook-bridge-beeper-linkedin.md | ||
| configuring-playbook-bridge-go-skype-bridge.md | ||
| configuring-playbook-bridge-heisenbridge.md | ||
| configuring-playbook-bridge-hookshot.md | ||
| configuring-playbook-bridge-matrix-bridge-sms.md | ||
| configuring-playbook-bridge-mautrix-discord.md | ||
| configuring-playbook-bridge-mautrix-facebook.md | ||
| configuring-playbook-bridge-mautrix-gmessages.md | ||
| configuring-playbook-bridge-mautrix-googlechat.md | ||
| configuring-playbook-bridge-mautrix-hangouts.md | ||
| configuring-playbook-bridge-mautrix-instagram.md | ||
| configuring-playbook-bridge-mautrix-meta-instagram.md | ||
| configuring-playbook-bridge-mautrix-meta-messenger.md | ||
| configuring-playbook-bridge-mautrix-signal.md | ||
| configuring-playbook-bridge-mautrix-slack.md | ||
| configuring-playbook-bridge-mautrix-telegram.md | ||
| configuring-playbook-bridge-mautrix-twitter.md | ||
| configuring-playbook-bridge-mautrix-whatsapp.md | ||
| configuring-playbook-bridge-mautrix-wsproxy.md | ||
| 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 | ||
| configuring-playbook-bridge-wechat.md | ||
| configuring-playbook-cactus-comments.md | ||
| configuring-playbook-client-cinny.md | ||
| configuring-playbook-client-element-web.md | ||
| configuring-playbook-client-hydrogen.md | ||
| configuring-playbook-client-schildichat-web.md | ||
| configuring-playbook-conduit.md | ||
| configuring-playbook-dendrite.md | ||
| configuring-playbook-dimension.md | ||
| configuring-playbook-dynamic-dns.md | ||
| configuring-playbook-email2matrix.md | ||
| configuring-playbook-email.md | ||
| configuring-playbook-etherpad.md | ||
| configuring-playbook-external-postgres.md | ||
| configuring-playbook-federation.md | ||
| configuring-playbook-jitsi.md | ||
| configuring-playbook-ldap-auth.md | ||
| configuring-playbook-ma1sd.md | ||
| configuring-playbook-matrix-authentication-service.md | ||
| configuring-playbook-matrix-corporal.md | ||
| configuring-playbook-matrix-ldap-registration-proxy.md | ||
| configuring-playbook-matrix-media-repo.md | ||
| configuring-playbook-matrix-registration.md | ||
| configuring-playbook-mautrix-bridges.md | ||
| configuring-playbook-nginx.md | ||
| configuring-playbook-ntfy.md | ||
| configuring-playbook-own-webserver.md | ||
| configuring-playbook-pantalaimon.md | ||
| configuring-playbook-postgres-backup.md | ||
| configuring-playbook-prometheus-grafana.md | ||
| configuring-playbook-prometheus-nginxlog.md | ||
| configuring-playbook-prometheus-postgres.md | ||
| configuring-playbook-rageshake.md | ||
| 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 | ||
| configuring-playbook-ssl-certificates.md | ||
| configuring-playbook-sygnal.md | ||
| configuring-playbook-synapse-admin.md | ||
| configuring-playbook-synapse-auto-accept-invite.md | ||
| configuring-playbook-synapse-auto-compressor.md | ||
| configuring-playbook-synapse-s3-storage-provider.md | ||
| configuring-playbook-synapse-simple-antispam.md | ||
| configuring-playbook-synapse-usage-exporter.md | ||
| configuring-playbook-synapse.md | ||
| configuring-playbook-telemetry.md | ||
| configuring-playbook-traefik.md | ||
| configuring-playbook-turn.md | ||
| configuring-playbook-user-verification-service.md | ||
| configuring-playbook.md | ||
| configuring-well-known.md | ||
| container-images.md | ||
| faq.md | ||
| getting-the-playbook.md | ||
| howto-server-delegation.md | ||
| howto-srv-server-delegation.md | ||
| importing-postgres.md | ||
| importing-synapse-media-store.md | ||
| importing-synapse-sqlite.md | ||
| installing.md | ||
| just.md | ||
| maintenance-and-troubleshooting.md | ||
| maintenance-checking-services.md | ||
| maintenance-migrating.md | ||
| maintenance-postgres.md | ||
| maintenance-synapse.md | ||
| maintenance-upgrading-services.md | ||
| obtaining-access-tokens.md | ||
| playbook-tags.md | ||
| prerequisites.md | ||
| quick-start.md | ||
| README.md | ||
| registering-users.md | ||
| self-building.md | ||
| uninstalling.md | ||
| updating-users-passwords.md | ||
Table of Contents
⬇️ Installaton guides
There are two installation guides available for beginners and advanced users.
-
⚡ Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults".
-
Full installation guide (for advanced users): if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide.
🛠️ 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_storefolder
- Other specialized services - various services that don't fit any other categories
👨🔧 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