diff --git a/README.md b/README.md index e02932f..289a0ef 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ # wifi-with-matrix -Bridge between https://code.ffdn.org/FFDN/wifi-with-me & a matrix room \ No newline at end of file +Bridge between https://code.ffdn.org/FFDN/wifi-with-me & a matrix room + +## Configuration + +Set the following environment variables: + +- MMW_BOT_MATRIX_URL: the url of the matrix homeserver +- MMW_BOT_MATRIX_ID: the user id of the bot on this server +- MMW_BOT_MATRIX_PW: the password for this user +- MMW_BOT_ROOM_ID: the room on which send the notifications + +## Dev + +``` +pip3 install --user matrix-client +./main.py +``` + +## Prod + +With a proxyta.net: + +``` +docker-compose up -d +``` + +## Test + +``` +curl -d '{"name":"toto", "url":"http://radio.localhost/map/#44"}' wwm.localhost +```