homer77
/
FritzAB2Matrix
1
0
Fork 0
Code Issues 3 Pull Requests Projects Releases 2 Wiki Activity

Corrected markdown.

This commit is contained in:
Homer S. 2021-06-29 23:17:27 +02:00
parent 77d5c633b2
commit cae5a40d52
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -20,16 +20,14 @@ If you like to test this repository you are recommended to use one of the follow
* `cd <new folder>` * `cd <new folder>`
* Clone the repo. * Clone the repo.
* Inside the repo run `pip install --update pip && pip install -r requirements.txt` * Inside the repo run `pip install --update pip && pip install -r requirements.txt`
+ Create an `.env` file with your favourite editor: * Create an `.env` file with your favourite editor:
``` ```
FRITZ_USERNAME="fritzab" FRITZ_USERNAME="fritzab"
FRITZ_PASSWORD="SomeRand0mPa55word" FRITZ_PASSWORD="SomeRand0mPa55word"
FRITZ_IP="192.168.178.1" FRITZ_IP="192.168.178.1"
FRITZ_TMP="/tmp" FRITZ_TMP="/tmp"
``` ```
* Adjust it according to your data. * Adjust it according to your data.
* For matrix-commander.py to work you need to run it manually the first time by `python3 matrix-commander` and follow the emerging dialog by putting in your matrix account data. * For matrix-commander.py to work you need to run it manually the first time by `python3 matrix-commander` and follow the emerging dialog by putting in your matrix account data.
* After all that you can finally run `./fritzab2matrix.py` and your TAM messages should be posted in the chosen matrix chat. * After all that you can finally run `./fritzab2matrix.py` and your TAM messages should be posted in the chosen matrix chat.
@ -40,11 +38,11 @@ Provided you have docker and docker-compose installed on your system:
* Run `docker-compose -f docker/docker-compose.yml build` and watch docker work some minutes. * Run `docker-compose -f docker/docker-compose.yml build` and watch docker work some minutes.
* After that slightly edit the `docker-compose.yml` * After that slightly edit the `docker-compose.yml`
* and add * and add
``` ```
volumes: volumes:
- ../.:/app - ../.:/app
``` ```
*
* so that your repo is used as volume for the `/app` folder. So everything you change in the repo's folder will affect the docker container. * so that your repo is used as volume for the `/app` folder. So everything you change in the repo's folder will affect the docker container.
* For __matrix-commander.py__ to work you need to run it manually the first time by `python3 matrix-commander` and follow the emerging dialog by putting in your matrix account data. * For __matrix-commander.py__ to work you need to run it manually the first time by `python3 matrix-commander` and follow the emerging dialog by putting in your matrix account data.