Edit installing instructions ()

* 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>
This commit is contained in:
Suguru Hirahara
2024-12-02 00:04:54 +09:00
committed by GitHub
parent c385b79498
commit bc1849d7ff
83 changed files with 195 additions and 165 deletions
docs
configuring-playbook-alertmanager-receiver.mdconfiguring-playbook-appservice-double-puppet.mdconfiguring-playbook-appservice-draupnir-for-all.mdconfiguring-playbook-backup-borg.mdconfiguring-playbook-bot-baibot.mdconfiguring-playbook-bot-buscarron.mdconfiguring-playbook-bot-chatgpt.mdconfiguring-playbook-bot-draupnir.mdconfiguring-playbook-bot-go-neb.mdconfiguring-playbook-bot-honoroit.mdconfiguring-playbook-bot-matrix-registration-bot.mdconfiguring-playbook-bot-matrix-reminder-bot.mdconfiguring-playbook-bot-maubot.mdconfiguring-playbook-bot-mjolnir.mdconfiguring-playbook-bridge-appservice-discord.mdconfiguring-playbook-bridge-appservice-irc.mdconfiguring-playbook-bridge-appservice-kakaotalk.mdconfiguring-playbook-bridge-appservice-slack.mdconfiguring-playbook-bridge-appservice-webhooks.mdconfiguring-playbook-bridge-beeper-linkedin.mdconfiguring-playbook-bridge-go-skype-bridge.mdconfiguring-playbook-bridge-heisenbridge.mdconfiguring-playbook-bridge-matrix-bridge-sms.mdconfiguring-playbook-bridge-mautrix-discord.mdconfiguring-playbook-bridge-mautrix-facebook.mdconfiguring-playbook-bridge-mautrix-gmessages.mdconfiguring-playbook-bridge-mautrix-googlechat.mdconfiguring-playbook-bridge-mautrix-hangouts.mdconfiguring-playbook-bridge-mautrix-instagram.mdconfiguring-playbook-bridge-mautrix-meta-instagram.mdconfiguring-playbook-bridge-mautrix-meta-messenger.mdconfiguring-playbook-bridge-mautrix-signal.mdconfiguring-playbook-bridge-mautrix-slack.mdconfiguring-playbook-bridge-mautrix-telegram.mdconfiguring-playbook-bridge-mautrix-twitter.mdconfiguring-playbook-bridge-mautrix-whatsapp.mdconfiguring-playbook-bridge-mautrix-wsproxy.mdconfiguring-playbook-bridge-mx-puppet-discord.mdconfiguring-playbook-bridge-mx-puppet-groupme.mdconfiguring-playbook-bridge-mx-puppet-instagram.mdconfiguring-playbook-bridge-mx-puppet-slack.mdconfiguring-playbook-bridge-mx-puppet-steam.mdconfiguring-playbook-bridge-mx-puppet-twitter.mdconfiguring-playbook-bridge-postmoogle.mdconfiguring-playbook-bridge-wechat.mdconfiguring-playbook-cactus-comments.mdconfiguring-playbook-client-cinny.mdconfiguring-playbook-client-element-web.mdconfiguring-playbook-client-hydrogen.mdconfiguring-playbook-client-schildichat-web.mdconfiguring-playbook-dendrite.mdconfiguring-playbook-dimension.mdconfiguring-playbook-dynamic-dns.mdconfiguring-playbook-email2matrix.mdconfiguring-playbook-etherpad.mdconfiguring-playbook-jitsi.mdconfiguring-playbook-ma1sd.mdconfiguring-playbook-matrix-authentication-service.mdconfiguring-playbook-matrix-corporal.mdconfiguring-playbook-matrix-ldap-registration-proxy.mdconfiguring-playbook-matrix-registration.mdconfiguring-playbook-mautrix-bridges.mdconfiguring-playbook-ntfy.mdconfiguring-playbook-pantalaimon.mdconfiguring-playbook-postgres-backup.mdconfiguring-playbook-prometheus-grafana.mdconfiguring-playbook-prometheus-nginxlog.mdconfiguring-playbook-prometheus-postgres.mdconfiguring-playbook-rageshake.mdconfiguring-playbook-rest-auth.mdconfiguring-playbook-riot-web.mdconfiguring-playbook-shared-secret-auth.mdconfiguring-playbook-sliding-sync-proxy.mdconfiguring-playbook-sygnal.mdconfiguring-playbook-synapse-admin.mdconfiguring-playbook-synapse-auto-compressor.mdconfiguring-playbook-synapse-usage-exporter.mdconfiguring-playbook-user-verification-service.mdfaq.mdinstalling.mdmaintenance-upgrading-services.mdquick-start.mdregistering-users.md

@ -91,8 +91,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-email2matrix,start
**Notes**:
- The shortcut commands with `just` program are also available: `just run-tags setup-email2matrix,start` or `just run-tags setup-all,start`
- The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-email2matrix,start` or `just setup-all`
`just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)
`just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too.
- After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected.