finn/matrix-bot-invitation-mailer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

📝 update README

Browse source
This commit is contained in:
Finn Christiansen 2024-11-19 22:41:01 +01:00
parent c65a9e472b
commit 01b34783cf
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -6,10 +6,22 @@ The bot calls the Api and sends the invitation link via e-mail to a given receip
## Usage
Use container image or run this after cloning:
Use container image or run this after cloning. In both cases you need to create a `.env` file containing the matrix and mail server credentials:
```
cp. .env.example .env
```
If you want to run it without the container you can run it like this:
```
. bin/activate
python -m matrix_bot_invitation_mailer
```
And for use with docker run it like this:
```
docker compose up -d
```