Update README and LICENSE
This commit is contained in:
parent
d7c53601fa
commit
423fd1c982
2
.gitignore
vendored
2
.gitignore
vendored
@ -114,3 +114,5 @@ dmypy.json
|
|||||||
# Pyre type checker
|
# Pyre type checker
|
||||||
.pyre/
|
.pyre/
|
||||||
|
|
||||||
|
# Databases
|
||||||
|
*.db
|
||||||
|
2
LICENSE
2
LICENSE
@ -2,7 +2,7 @@ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
|||||||
|
|
||||||
Version 2, December 2004
|
Version 2, December 2004
|
||||||
|
|
||||||
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
|
Copyright (C) 2022 Andrej Pillar <192235@vutbr.cz>
|
||||||
|
|
||||||
Everyone is permitted to copy and distribute verbatim or modified copies of
|
Everyone is permitted to copy and distribute verbatim or modified copies of
|
||||||
this license document, and changing it is allowed as long as the name is changed.
|
this license document, and changing it is allowed as long as the name is changed.
|
||||||
|
11
README.md
11
README.md
@ -1,13 +1,12 @@
|
|||||||
# thesis_server
|
# inenvmon_server
|
||||||
|
|
||||||
Serverside stuff for thesis project.
|
Serverside stuff for thesis project.
|
||||||
Some components are under a different license.
|
Some components are under a different license.
|
||||||
|
|
||||||
### webapp
|
The provided Dockerfile builds a monolith container providing an MQTT broker, data collector, data access API and a webapp.
|
||||||
|
|
||||||
Files for a flask webapp to visualise data from database.
|
Passwords should be set up before deploying the container. The MQTT password should substitute the string `mqttsecret` in `inenvmon/inenvmon_collector.py` and `mosquitto_users` and the API secret should substitute the string `itsasecret` in `inenvmon/inenvmon_collector.py` and `inenvmon/web/inenvmon_web.py`
|
||||||
|
|
||||||
### inenvmon_collector.py
|
The MQTT broker is running on port 9888 and the API/webapp on port 8080. Mapping to host ports can be adjusted in docker-compose.yml
|
||||||
|
|
||||||
A helper script to listen to mqtt topic and write relevant data into the database.
|
The legacy version can be found in the `legacy` branch of this repository.
|
||||||
Also takes care of timestamping and reporting source status to web app.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user