NoLog.cz/matrix-invitation-dealer
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

add README

Browse source
This commit is contained in:
bain 2023-10-13 21:28:11 +02:00
parent 36a1867ed5
commit e3d204bc90
Signed by: bain
GPG key ID: 31F0F25E3BED0B9B
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md Normal file
View file

@ -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/<user_id>` 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.