matrix-docker-ansible-deploy/docs
Julian-Samuel Gebühr 90a142439a
Add matrix-registration-bot (#1771)
* Add matrix-registration-bot

This adds an install and uninstall task plus helpers. The bot is disabled by default.
This commit does not include documentation, yet. In short, the bot can be enabled by adding
matrix_bot_matrix_registration_bot_enabled: true
matrix_bot_matrix_registration_bot_matrix_user_password: "verysecret"
matrix_bot_matrix_registration_bot_matrix_admin_token: "supersecret"
to the host_vars

* Change bot username to bot.matrix-registration-bot following convention

* Address smaller remarks, fix local docker build

* Switch to an env file

* Add environment variables extension for additional config

* Add documentation for the matrix-registration-bot

* Add screenshot on how to obtain admin access token

* Use bot as admin to only have one access token (bot and admin api)

* Use cleaner setting of matrix_synapse_registration_requires_token

* Use config file for cleaner more secure usage

* Delete unneeded env

* Rename vars to make usage clear

* Fix typos/wording and add notice about logging out

* Convert configuration to use |to_json

* Reorder role includes

Nothing should be after `matrix-common-after`.

`matrix-bot-matrix-registration-bot` can probably be anywhere, but it makes sense to put it next to the other `matrix-bot-*` roles.

* Minor group_vars/matrix_servers touchups

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2022-04-21 11:07:47 +03:00
..
assets Add matrix-registration-bot (#1771) 2022-04-21 11:07:47 +03:00
alternative-architectures.md Mention that Hydrogen always undergoes self-building 2021-10-27 14:00:40 +03:00
ansible.md Upgrade devture/ansible (2.10.7-r0 -> 2.11.6-r1) 2021-12-23 12:01:53 +02:00
configuring-captcha.md Simplify enabling recaptcha instructions a bit 2020-07-04 09:35:20 +03:00
configuring-dns.md Do not install the ma1sd identity server by default 2022-03-17 18:00:09 +02:00
configuring-playbook-backup-borg.md Announce borg backup support 2022-04-19 19:29:41 +03:00
configuring-playbook-base-domain-serving.md Be explicit about the type of DNS record to use 2020-07-21 11:20:00 +00:00
configuring-playbook-bot-go-neb.md Fix go-neb sample configuration to not clash with Jinja2 2022-01-15 09:07:24 +02:00
configuring-playbook-bot-honoroit.md added honoroit 2022-01-06 20:30:10 +02:00
configuring-playbook-bot-matrix-registration-bot.md Add matrix-registration-bot (#1771) 2022-04-21 11:07:47 +03:00
configuring-playbook-bot-matrix-reminder-bot.md docs: fix matrix-reminder-bot help menu command 2022-02-02 12:35:12 +05:30
configuring-playbook-bot-mjolnir.md Removing antispam note. 2021-05-26 09:05:28 +02:00
configuring-playbook-bridge-appservice-discord.md docs(appservice-discord): improve and expand bridging method docs 2022-03-06 01:56:24 +00:00
configuring-playbook-bridge-appservice-irc.md Cross-link similar bridges 2021-05-19 13:32:05 +03:00
configuring-playbook-bridge-appservice-slack.md Riot is now named Element 2022-03-08 09:11:04 +01:00
configuring-playbook-bridge-appservice-webhooks.md Link appservice-webhooks to hookshot 2022-02-01 13:25:02 +01:00
configuring-playbook-bridge-beeper-linkedin.md Announce LinkedIn Messaging bridging support 2021-08-23 15:27:16 +03:00
configuring-playbook-bridge-heisenbridge.md Link to Heisenbridge demonstration video 2021-06-04 09:32:31 +03:00
configuring-playbook-bridge-hookshot.md Upgrade Hookshot (1.3.0 -> 1.4.0) 2022-04-11 18:55:02 +02:00
configuring-playbook-bridge-matrix-bridge-sms.md Update configuring-playbook-bridge-matrix-bridge-sms.md 2020-11-25 15:39:14 +01:00
configuring-playbook-bridge-mautrix-facebook.md Remove deprecated community options 2022-03-05 21:57:30 +01:00
configuring-playbook-bridge-mautrix-googlechat.md Added Mautrix Google Chat 2021-10-12 11:45:04 +00:00
configuring-playbook-bridge-mautrix-hangouts.md Updated Hangouts configuration readme. 2021-10-12 17:08:17 +00:00
configuring-playbook-bridge-mautrix-instagram.md Update configuring-playbook-bridge-mautrix-instagram.md 2021-08-18 17:00:47 +02:00
configuring-playbook-bridge-mautrix-signal.md Update configuring-playbook-bridge-mautrix-signal.md 2021-08-18 17:03:20 +02:00
configuring-playbook-bridge-mautrix-telegram.md Improved documentation about permissions 2022-03-17 20:20:43 +00:00
configuring-playbook-bridge-mautrix-twitter.md Update links to Mautrix Twitter bridge 2022-01-03 01:05:13 +00:00
configuring-playbook-bridge-mautrix-whatsapp.md updated whatsapp config 2021-11-15 19:34:56 +01:00
configuring-playbook-bridge-mx-puppet-discord.md Switch to the Beeper-maintained fork of mx-puppet-discord 2022-03-10 12:27:53 +02:00
configuring-playbook-bridge-mx-puppet-groupme.md Remove unused variables from mx-puppet-* bridges 2021-06-23 09:56:31 +03:00
configuring-playbook-bridge-mx-puppet-instagram.md mx-puppet-instagram: add documentation on how to setup & use the bridge 2020-06-28 10:46:39 +02:00
configuring-playbook-bridge-mx-puppet-skype.md Rename documentation file 2020-04-09 09:26:03 +03:00
configuring-playbook-bridge-mx-puppet-slack.md Switch mx-puppet-slack to the beeper fork (#1704) 2022-03-17 22:16:17 +02:00
configuring-playbook-bridge-mx-puppet-steam.md Remove unused variables from mx-puppet-* bridges 2021-06-23 09:56:31 +03:00
configuring-playbook-bridge-mx-puppet-twitter.md Announce mautrix-twitter support 2021-12-22 15:53:56 +02:00
configuring-playbook-client-cinny.md added matrix-client-cinny 2022-01-05 18:33:21 +02:00
configuring-playbook-client-element.md Switch to the new vectorim/element-web Docker image 2020-10-29 11:46:58 -05:00
configuring-playbook-client-hydrogen.md merge with upstream 2021-05-25 21:08:00 +08:00
configuring-playbook-dimension.md Update configuring-playbook-dimension.md 2022-03-18 14:52:25 -06:00
configuring-playbook-dynamic-dns.md Announce Dynamic DNS support 2020-11-11 00:01:08 +02:00
configuring-playbook-email.md Typo STMP -> SMTP 2020-05-16 14:49:12 +02:00
configuring-playbook-email2matrix.md Mention Email2Matrix usage alongside Postfix 2019-08-09 12:15:44 +03:00
configuring-playbook-etherpad.md feat(etherpad): add optional admin web-UI access 2022-01-01 03:12:14 +00:00
configuring-playbook-external-postgres.md Document that using an external Postgres server has serious downsides 2022-03-08 09:30:20 +02:00
configuring-playbook-federation.md fix typo 2022-02-20 11:56:03 +01:00
configuring-playbook-jitsi.md Updated documentation to better reflect the workings of Jitsi internal authentication with this playbook 2021-12-09 07:58:50 -03:00
configuring-playbook-ldap-auth.md Replace mxisd with ma1sd in docs, fixing URLs 2020-04-02 11:26:30 +02:00
configuring-playbook-ma1sd.md Do not install the ma1sd identity server by default 2022-03-17 18:00:09 +02:00
configuring-playbook-matrix-corporal.md Update matrix-corporal documentation 2021-11-15 10:29:27 +02:00
configuring-playbook-matrix-registration.md Fix one more URL typo 2021-01-12 22:44:55 +02:00
configuring-playbook-nginx.md Touch up documentation a bit 2021-02-14 11:05:05 +02:00
configuring-playbook-own-webserver.md Link to examples/caddy2 2021-12-25 10:48:06 +02:00
configuring-playbook-postgres-backup.md Announce borg backup support 2022-04-19 19:29:41 +03:00
configuring-playbook-prometheus-grafana.md Add note about Prometheus retention policy 2022-03-29 22:26:29 +02:00
configuring-playbook-prometheus-postgres.md Minor correction 2021-05-28 09:31:55 +02:00
configuring-playbook-rest-auth.md Replace mxisd with ma1sd in docs, fixing URLs 2020-04-02 11:26:30 +02:00
configuring-playbook-riot-web.md Add information about deleting SSL renewal config 2020-07-23 08:15:18 +03:00
configuring-playbook-s3.md Improve S3 docs around data migration 2021-02-09 22:09:08 +02:00
configuring-playbook-shared-secret-auth.md Mention pwgen for generating a strong shared secret 2020-05-29 10:38:12 +03:00
configuring-playbook-ssl-certificates.md Add support for obtain ECDSA keys (#1667) 2022-03-03 18:15:39 +02:00
configuring-playbook-sygnal.md Fix YAML indentation in docs 2021-03-25 09:02:35 +02:00
configuring-playbook-synapse-admin.md merge with upstream 2021-05-25 21:08:00 +08:00
configuring-playbook-synapse-simple-antispam.md Add support for Synapse Simple Antispam 2019-09-09 08:13:10 +03:00
configuring-playbook-synapse.md Fix template syntax error in OIDC SSO example 2021-07-05 14:47:50 +07:00
configuring-playbook-telemetry.md Update configuring-playbook-telemetry.md 2020-09-07 17:14:34 +03:00
configuring-playbook-turn.md Added a documentation enhancement regarding external TURN server 2020-05-05 08:42:14 +02:00
configuring-playbook.md Add matrix-registration-bot (#1771) 2022-04-21 11:07:47 +03:00
configuring-well-known.md Update configuring-well-known.md 2021-07-24 13:12:32 +02:00
container-images.md Do not install the ma1sd identity server by default 2022-03-17 18:00:09 +02:00
faq.md Update faq.md 2022-02-16 10:25:36 +02:00
getting-the-playbook.md Improve documentation about getting the playbook 2019-03-10 17:02:20 +02:00
howto-server-delegation.md Update howto-server-delegation.md 2021-08-01 19:34:54 +00:00
importing-postgres.md Update importing-postgres.md with individual DB and repeat-import information (#1437) 2021-12-05 10:41:00 +02:00
importing-synapse-media-store.md Rename some doc files and commands related to importing 2020-12-14 01:51:00 +02:00
importing-synapse-sqlite.md Rename some doc files and commands related to importing 2020-12-14 01:51:00 +02:00
installing.md Update installing.md to be a bit more clear 2021-10-19 22:57:01 -05:00
maintenance-and-troubleshooting.md add some doc about the run-docker-prune tag 2020-10-10 14:27:07 +02:00
maintenance-checking-services.md Update URL for Matrix federation tester 2019-05-09 07:04:46 +02:00
maintenance-migrating.md merge upstream 2021-06-01 16:00:13 +08:00
maintenance-postgres.md merge upstream 2021-06-01 16:00:13 +08:00
maintenance-synapse.md Correct broken documentation link 2021-07-01 22:16:01 +02:00
maintenance-upgrading-services.md Fix typos and improve wording 2020-06-01 22:32:19 +03:00
prerequisites.md Do not advertise Debian 9 support 2021-09-21 10:57:32 +03:00
README.md Initial work on a FAQ document 2021-01-21 12:55:17 +02:00
registering-users.md Mention CAPTCHA for public-registration servers 2020-09-01 14:00:17 +03:00
self-building.md Merge pull request #1728 from RoiArthurB/hookshot-arm64 2022-04-05 09:58:26 +03:00
uninstalling.md Replace cronjobs with systemd timers 2021-01-14 23:35:50 +02:00
updating-users-passwords.md Update updating-users-passwords.md 2020-12-23 11:23:09 +01:00