aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 7efd50d..9226cf4 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,25 @@
# mqtt
-Documentation and source code for departmental mqtt server hosted at https://mosquitto.chem.wisc.edu.
+Documentation and source code for the departmental mqtt server hosted at https://mqtt.chem.wisc.edu.
To prepare (starting with Ubuntu 20.04)
```
$ apt install docker.io
-$ apt install docker compose
+$ apt install docker-compose
```
This machine needs the following ports to be open to the campus network:
-- 80 (http)
+- 80 (http) (used via reverse proxy)
- 1883 (mqtt)
- 8086 (influxdb)
To run:
```
$ docker-compose up -d --build
-``` \ No newline at end of file
+```
+
+Volumes:
+
+This compose file will create a docker volume `mqtt_influxdb`.
+This volume contains the influx database itself and should be backed up.
+On the host machine it appears at `/var/lib/docker/volumes/mqtt_influxdb/`. \ No newline at end of file