matrix-docker-ansible-deploy

mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-04-19 10:48:45 +02:00

History

Suguru Hirahara 8a83b11ece

Update docs/installing.md and docs/quick-start.md: mention "make roles"

This commit adds mentions to "make roles" and a note about the preference of ansible-playbook commands over the just "recipes".

quick-start.md intends to be referred by those who have never used the playbook to set up a server, so it is safer to regard that it is not clear to them what exactly the just "recipes" are made of, ie. it takes some time and experience until someone understands simplicity of them. For beginners, I believe that we should prefer the basics over simplicity, from the educational point of view.

If someone feels tired of using the same command repetitively, then the person will have been already well accustomed to the way how the playbook works and how the server is supposed to be maintained, and the person is "qualified" to use the just "recipes", and should be able to use them with confidence, distinguishing the playbook tags from the "recipes", for example, from "just install-all" and "ansible-playbook -i inventory/hosts setup.yml --tags=install-all". Such level of familiarity and experience should not be expected on the quick start guide.

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

2024-11-23 01:51:24 +09: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

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

configuring-captcha.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

configuring-dns.md

Update docs/configuring-dns.md: sync with docs/quick-start.md

2024-11-22 15:58:17 +09:00

configuring-playbook-alertmanager-receiver.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-appservice-double-puppet.md

Replace DOMAIN with example.com

2024-10-18 04:02:02 +09:00

configuring-playbook-appservice-draupnir-for-all.md

Add "Web" to Element and SchildiChat web application (#3755 )

2024-11-07 16:31:26 +02:00

configuring-playbook-backup-borg.md

Update docs/configuring-playbook-backup-borg.md (#3724 )

2024-11-02 17:38:06 +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

Replace another.com with example.net

2024-10-18 04:03:23 +09:00

configuring-playbook-bot-buscarron.md

Fix capitalization: buscarron → Buscarron

2024-10-28 04:00:30 +09:00

configuring-playbook-bot-chatgpt.md

Fix capitalization: element → Element

2024-11-08 20:30:59 +09:00

configuring-playbook-bot-draupnir.md

Fix broken anchor links

2024-11-17 21:30:47 +09:00

configuring-playbook-bot-go-neb.md

Update documentation titles of deprecated or unmaintained services

2024-11-01 17:31:53 +09: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

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09: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

Fix broken anchor links

2024-11-17 21:30:47 +09:00

configuring-playbook-bridge-appservice-discord.md

Update the URL to matrix-appservice-discord

2024-10-28 17:18:03 +09: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

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-appservice-slack.md

Add "Web" to Element and SchildiChat web application (#3755 )

2024-11-07 16:31:26 +02:00

configuring-playbook-bridge-appservice-webhooks.md

Update docs/configuring-playbook-bridge-appservice-webhooks.md

2024-11-03 01:59:26 +09:00

configuring-playbook-bridge-beeper-linkedin.md

Fix broken anchor links

2024-11-17 21:30:47 +09: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

Update docs/configuring-playbook-bridge-hookshot.md: fix link to main.yml

2024-11-17 20:24:01 +09: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

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-facebook.md

Update documentation titles of deprecated or unmaintained services

2024-11-01 17:31:53 +09:00

configuring-playbook-bridge-mautrix-gmessages.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-googlechat.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-hangouts.md

Update documentation titles of deprecated or unmaintained services

2024-11-01 17:31:53 +09: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 docs/configuring-playbook-bridge-mautrix-meta-instagram.md: the same paragraph as docs/configuring-playbook-bridge-mautrix-meta-messenger.md

2024-11-01 21:59:20 +09:00

configuring-playbook-bridge-mautrix-meta-messenger.md

Update docs/configuring-playbook-bridge-mautrix-meta-messenger.md: add a note about user ID of the new bridge's bot

2024-11-01 21:53:28 +09:00

configuring-playbook-bridge-mautrix-signal.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-slack.md

Update documentation about Slack bridges (#3706 )

2024-10-31 11:58:04 +02:00

configuring-playbook-bridge-mautrix-telegram.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-twitter.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-bridge-mautrix-whatsapp.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09: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 documentation about Slack bridges (#3706 )

2024-10-31 11:58:04 +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

Add "Web" to Element and SchildiChat web application (#3755 )

2024-11-07 16:31:26 +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

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +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 docs/configuring-playbook-federation.md: add note about setting server delegation

2024-11-15 18:01:19 +09:00

configuring-playbook-jitsi.md

Fix broken anchor links

2024-11-17 21:30:47 +09:00

configuring-playbook-ldap-auth.md

Replace DOMAIN with example.com

2024-10-18 04:02:02 +09:00

configuring-playbook-ma1sd.md

Fix broken anchor links

2024-11-17 21:30:47 +09:00

configuring-playbook-matrix-authentication-service.md

Fix capitalization: ids → IDs

2024-11-08 20:31:07 +09: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

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

configuring-playbook-mautrix-bridges.md

docs/configuring-playbook-mautrix-bridges.md: fix periods

2024-10-24 15:33:57 +09: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

Add "Web" to Element and SchildiChat web application (#3755 )

2024-11-07 16:31:26 +02:00

configuring-playbook-own-webserver.md

Announce HTTP-compression and timeout adjustments for Traefik-based setups

2024-11-14 17:13:14 +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

Consistent usage of the words related to BorgBackup (Borg)

2024-10-24 16:30:00 +09: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

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09: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

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-synapse-admin.md

Mention publicly hosted services for Cinny, Element and synapse-admin

2024-11-09 21:18:39 +02:00

configuring-playbook-synapse-auto-accept-invite.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

configuring-playbook-synapse-auto-compressor.md

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09: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

Correct issuer URL in OIDC example section

2024-11-16 20:56:15 -07: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

Synchronize document titles and links based on configuring-playbook.md

2024-10-26 21:28:31 +09:00

configuring-playbook-user-verification-service.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

configuring-playbook.md

Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md

2024-11-21 14:09:41 +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

Fix broken anchor links

2024-11-17 21:30:47 +09:00

getting-the-playbook.md

Change the link to 'Quick start' on the breadcrumbs from README.md to quick-start.md

2024-11-21 14:09:41 +09: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

Fix incorrect variable name in docs/howto-srv-server-delegation.md (traefik_environment_variables -> traefik_environment_variables_additional_variables)

2024-11-18 07:44:44 +02:00

importing-postgres.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09: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

Update docs/installing.md and docs/quick-start.md: mention "make roles"

2024-11-23 01:51:24 +09:00

maintenance-and-troubleshooting.md

Replace existing links to matrix-org/synapse which should be replaced

2024-10-28 16:43:35 +09:00

maintenance-checking-services.md

Update URL for Matrix federation tester

2019-05-09 07:04:46 +02:00

maintenance-migrating.md

Replace DOMAIN with example.com

2024-10-18 04:02:02 +09:00

maintenance-postgres.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

maintenance-synapse.md

Edit line breaks in sentences and paragraphs

2024-10-23 01:13:23 +09:00

maintenance-upgrading-services.md

Add description about keeping the playbook and services up-to-date

2024-11-21 14:09:20 +09:00

obtaining-access-tokens.md

Add "Web" to Element and SchildiChat web application (#3755 )

2024-11-07 16:31:26 +02:00

playbook-tags.md

Create docs/playbook-tags.md: move explanation about playbook tags

2024-11-09 03:28:45 +09:00

prerequisites.md

Add note about using "example.com" as an example domain

2024-11-21 14:10:00 +09:00

quick-start.md

Update docs/installing.md and docs/quick-start.md: mention "make roles"

2024-11-23 01:51:24 +09:00

README.md

Add a link to quick-start.md on docs/README.md

2024-11-21 14:09:50 +09:00

registering-users.md

Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders

2024-11-22 16:21:42 +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

Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders

2024-11-22 16:21:42 +09:00

README.md

FAQ - lots of questions and answers. Jump to Prerequisites to avoid reading too much and to just start a guided installation.
Quick start - follow the guide to set up minimum core services on your server
Prerequisites - go here to a guided installation using this Ansible playbook
Configuring your DNS settings
Getting this playbook's source code
Configuring the playbook
Installing
- Importing data from another server installation
- Server Delegation
  - Server Delegation via a well-known file (recommended): Installing well-known files on the base domain's server
    - Serving the base domain
  - Server Delegation via a DNS SRV record (advanced)
Playbook tags
Registering users
Updating users passwords
Maintenance / checking if services work
Maintenance / upgrading services
Maintenance / Synapse
Maintenance / PostgreSQL
Maintenance and Troubleshooting
Uninstalling

README.md

Table of Contents