From 8bad3bb73bc0e4db1f2e0d5e5009fca446865d50 Mon Sep 17 00:00:00 2001
From: liamcottle <liam@liamcottle.com>
Date: Sat, 15 Jun 2024 15:05:08 +1200
Subject: [PATCH] add docker compose to readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index ce8c4d7..ac0cb2d 100644
--- a/README.md
+++ b/README.md
@@ -213,6 +213,22 @@ As of the time of writing these docs, the mobile devices do not correctly config
 
 Your node will stay "stuck" in the `online` state in the MQTT server.
 
+## Docker Compose
+
+A [docker-compose.yml](./docker-compose.yml) is available. You can run the following command to launch everything;
+
+```
+docker compose up
+```
+
+This will:
+
+- Start a MariaDB database server.
+- Run the database migrations.
+- Start the MQTT collector.
+- Start the Map UI.
+- Expose the map on port 8080.
+
 ## Contributing
 
 If you have a feature request, or find a bug, please [open an issue](https://github.com/liamcottle/meshtastic-map/issues) here on GitHub.