📝 update README
This commit is contained in:
parent
c65a9e472b
commit
01b34783cf
1 changed files with 13 additions and 1 deletions
14
README.md
14
README.md
|
@ -6,10 +6,22 @@ The bot calls the Api and sends the invitation link via e-mail to a given receip
|
||||||
|
|
||||||
## Usage
|
## 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
|
. bin/activate
|
||||||
python -m matrix_bot_invitation_mailer
|
python -m matrix_bot_invitation_mailer
|
||||||
```
|
```
|
||||||
|
|
||||||
|
And for use with docker run it like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue