From 42e53f6e5ea784d72aec5c79e9c00a48f92d990d Mon Sep 17 00:00:00 2001
From: LRVT <21357789+l4rm4nd@users.noreply.github.com>
Date: Fri, 22 Nov 2024 15:53:33 +0100
Subject: [PATCH] chore: add scratch-map

---
 README.md                               |  1 +
 examples/scratch-map/README.md          | 11 ++++++++++
 examples/scratch-map/docker-compose.yml | 28 +++++++++++++++++++++++++
 3 files changed, 40 insertions(+)
 create mode 100644 examples/scratch-map/README.md
 create mode 100644 examples/scratch-map/docker-compose.yml

diff --git a/README.md b/README.md
index ea6a893..30567a0 100644
--- a/README.md
+++ b/README.md
@@ -451,6 +451,7 @@ Software that does not fit in another section.
 
 - [Network-Multitool](examples/network-multitool) - Multi-arch multitool for container network troubleshooting.
 - [IT-Tools](examples/it-tools) - Collection of handy online tools for developers, with great UX.
+- [Scratch-Map](examples/scratch-map) - An open-source scratch-off style map to track your travels.
 
 ## 🌟 Star History
 [![Star History Chart](https://api.star-history.com/svg?repos=Haxxnet/Compose-Examples&type=Date)](https://star-history.com/#Haxxnet/Compose-Examples&Date)
diff --git a/examples/scratch-map/README.md b/examples/scratch-map/README.md
new file mode 100644
index 0000000..b746a41
--- /dev/null
+++ b/examples/scratch-map/README.md
@@ -0,0 +1,11 @@
+# References
+
+- https://github.com/ad3m3r5/scratch-map
+
+# Notes
+
+May require you to fix permissions of the bind mount volume:
+
+````
+sudo chown -R 1000:1000 ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/scratch-map
+````
diff --git a/examples/scratch-map/docker-compose.yml b/examples/scratch-map/docker-compose.yml
new file mode 100644
index 0000000..3a0dd5a
--- /dev/null
+++ b/examples/scratch-map/docker-compose.yml
@@ -0,0 +1,28 @@
+services:
+
+  scratchmap:
+    image: ad3m3r5/scratch-map:latest
+    container_name: scratch-map
+    restart: unless-stopped
+    ports:
+      - 8080:8080/tcp # http ui
+    expose:
+      - 8080/tcp
+    volumes:
+      - ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/scratch-map:/data
+    environment:
+      - DBLOCATION=/data
+      - PORT=8080
+    #networks:
+    #  - proxy
+    #labels:
+    #  - traefik.enable=true
+    #  - traefik.docker.network=proxy
+    #  - traefik.http.routers.scratchmap.rule=Host(`earth.example.com`)
+    #  - traefik.http.services.scratchmap.loadbalancer.server.port=8080
+    #  # Optional part for traefik middlewares
+    #  - traefik.http.routers.scratchmap.middlewares=local-ipwhitelist@file
+
+#networks:
+#  proxy:
+#    external: true