matrix-docker-ansible-deploy

mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-02-04 22:35:02 +01:00

History

Suguru Hirahara 9a56aff933

Edit docs for bots: adopt the common format

- Add "To use the bot" if it does not exist: adopt the format of the docs for bridges
- Add "Prerequisites" section if an API key or user account is required
- Use the common instruction for getting an access token
- Replace "Get" with "Obtain" about getting keys or access tokens
- Replace placeholders for access tokens on docs/configuring-playbook-bot-go.neb.md

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

2024-12-23 13:11:38 +09:00

assets

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

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

alternative-architectures.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

ansible.md

Upgrade devture/ansible (2.17.0-r0-2 -> 2.18.1-r0-0)

2024-12-08 12:10:44 +02:00

configuring-captcha.md

Adjust blank lines: add ones

2024-12-02 03:14:48 +09:00

configuring-dns.md

Edit docs/configuring-dns.md: clarify user ID shortness

2024-12-09 14:41:30 +09:00

configuring-playbook-alertmanager-receiver.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-appservice-double-puppet.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

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

Update docs for D4A, Draupnir, and Mjolnir (#3872 )

2024-12-17 15:41:10 +02:00

configuring-playbook-backup-borg.md

Edit docs: consistent instructions to generate passphrases or secrets with pwgen

2024-12-22 17:53:14 +09:00

configuring-playbook-base-domain-serving.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-bot-baibot.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-buscarron.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-chatgpt.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-draupnir.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-go-neb.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-honoroit.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-matrix-registration-bot.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-matrix-reminder-bot.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-maubot.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bot-mjolnir.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-bridge-appservice-discord.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-appservice-irc.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-appservice-kakaotalk.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-bridge-appservice-slack.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-appservice-webhooks.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-beeper-linkedin.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-go-skype-bridge.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-heisenbridge.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-bridge-hookshot.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-matrix-bridge-sms.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-bridge-mautrix-discord.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mautrix-facebook.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-gmessages.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-googlechat.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-hangouts.md

Merge pull request #3862 from luixxiul/fix

2024-12-12 09:29:21 +02:00

configuring-playbook-bridge-mautrix-instagram.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

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

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

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

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-signal.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-slack.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mautrix-telegram.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-twitter.md

Merge pull request #3877 from luixxiul/patch-1

2024-12-17 12:25:21 +02:00

configuring-playbook-bridge-mautrix-whatsapp.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +09:00

configuring-playbook-bridge-mautrix-wsproxy.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-bridge-mx-puppet-discord.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mx-puppet-groupme.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mx-puppet-instagram.md

Consistent "send help" messages

2024-12-20 23:17:20 +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

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mx-puppet-steam.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-mx-puppet-twitter.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-bridge-postmoogle.md

Edit docs: consistent instructions to generate passphrases or secrets with pwgen

2024-12-22 17:53:14 +09:00

configuring-playbook-bridge-wechat.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-cactus-comments.md

Consistent "send help" messages

2024-12-20 23:17:20 +09:00

configuring-playbook-client-cinny.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-client-element-web.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-client-hydrogen.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-client-schildichat-web.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-conduit.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-dendrite.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-dimension.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-dynamic-dns.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-email2matrix.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +09:00

configuring-playbook-email.md

Adjust blank lines: add ones

2024-12-02 03:14:48 +09:00

configuring-playbook-etherpad.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-external-postgres.md

Replace DOMAIN with example.com

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

configuring-playbook-federation.md

Edit docs/configuring-dns.md: clarify user ID shortness

2024-12-09 14:41:30 +09:00

configuring-playbook-jitsi.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-ldap-auth.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-ma1sd.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-matrix-authentication-service.md

Edit user identifier examples: to @alice and @bob

2024-12-09 14:40:41 +09:00

configuring-playbook-matrix-corporal.md

Initial work on translations / localization

2024-12-20 09:37:38 +02:00

configuring-playbook-matrix-ldap-registration-proxy.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-matrix-media-repo.md

Edit user identifier examples: to @alice

2024-12-09 14:40:49 +09:00

configuring-playbook-matrix-registration.md

Edit docs: consistent instructions to generate passphrases or secrets with pwgen

2024-12-22 17:53:14 +09:00

configuring-playbook-mautrix-bridges.md

Use common expressions for using a bridge

2024-12-09 14:41:38 +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

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-own-webserver.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-pantalaimon.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-postgres-backup.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-prometheus-grafana.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-prometheus-nginxlog.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-prometheus-postgres.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-rageshake.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-rest-auth.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-riot-web.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-s3-goofys.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-s3.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-shared-secret-auth.md

Edit docs: consistent instructions to generate passphrases or secrets with pwgen

2024-12-22 17:53:14 +09:00

configuring-playbook-sliding-sync-proxy.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-ssl-certificates.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-sygnal.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-synapse-admin.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

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

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-synapse-auto-compressor.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-synapse-s3-storage-provider.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-synapse-simple-antispam.md

Update docs: adopt common expressions to encourage readers to check projects' documentation

2024-12-17 18:50:53 +09:00

configuring-playbook-synapse-usage-exporter.md

Mention how much "just install-all" is faster than "just setup-all"

2024-12-02 20:00:58 +09:00

configuring-playbook-synapse.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-telemetry.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-traefik.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-turn.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-playbook-user-verification-service.md

Edit docs/configuring-playbook-bridge-hookshot.md and two other documents about installing instruction (#3886 )

2024-12-18 09:46:12 +02:00

configuring-playbook.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

configuring-well-known.md

Edit docs/configuring-dns.md: clarify user ID shortness

2024-12-09 14:41:30 +09:00

container-images.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

faq.md

Use common strings: "user ID"

2024-12-09 14:41:08 +09:00

getting-the-playbook.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

howto-server-delegation.md

Edit docs for bots: adopt the common format

2024-12-23 13:11:38 +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

Replace triple dots with horizontal ellipsis (U+2026)

2024-12-06 13:34:50 +09:00

importing-synapse-media-store.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

importing-synapse-sqlite.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

installing.md

Use common strings: change "full identifier" to "full ID"

2024-12-09 14:41:12 +09:00

just.md

Use "alice" as placeholder username instead of "john"

2024-11-28 22:11:47 +09:00

maintenance-and-troubleshooting.md

Adjust blank lines: add ones

2024-12-02 03:14:48 +09: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

Adjust blank lines: add ones

2024-12-02 03:14:48 +09:00

maintenance-synapse.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

maintenance-upgrading-services.md

Edit docs/maintenance-upgrading-services.md: add details about the difference between install-all and setup-all in speed

2024-12-02 19:58:24 +09:00

obtaining-access-tokens.md

Edit user identifier examples: to @alice

2024-12-09 14:40:49 +09: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 common strings: change "full identifier" to "full ID"

2024-12-09 14:41:12 +09:00

README.md

Update README.md: remove a redundant whitespace character

2024-12-06 13:34:46 +09:00

registering-users.md

Use common strings: change "full identifier" to "full ID"

2024-12-09 14:41:12 +09:00

self-building.md

Add Pantalaimon support

2024-03-24 18:35:34 +02:00

uninstalling.md

Adjust blank lines: remove duplicated ones

2024-12-02 03:14:39 +09:00

updating-users-passwords.md

Use common strings: change "full identifier" to "full ID"

2024-12-09 14:41:12 +09:00

README.md

⬇️ 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_store folder

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.

README.md

Table of Contents

⬇️ Installaton guides

🛠️ Configuration options

👨‍🔧 Maintenance

Other documentation pages

README.md Unescape Escape

Table of Contents

⬇️ Installaton guides

🛠️ Configuration options

👨‍🔧 Maintenance

Other documentation pages

README.md