diff --git a/README.md b/README.md new file mode 100644 index 0000000..6c9cd98 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Matrix invitation dealer + +Matrix bot for distribution of synapse registration tokens. All users are +allowed to create registration tokens after a preconfigured wait period. + +## Installation + +Best way to install is using docker and docker compose. + +1. Fill in the environment variables in `docker-compose.yml` +2. Run `docker compose up` +3. The bot will initialize and quit. You must verify its session through any + other matrix client. It does not support cross-signing, so you must verify + **manually** using the key fingerprint. To manually verify a session in + Element, open your account in the sidebar (for example by putting + `/#/user/` as your browser path), click on "sessions", and then on + the session which is not verified. +4. Run the bot again. It should now start and keep running.