task: add examples

jop-software · Aug 2, 2022 · b9d95fa · b9d95fa
1 parent cf66f27
commit b9d95fa
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,21 @@ http://127.0.0.1:9101/probe?mailbox=INBOX
 probe_mailbox_count 0
 ```
 
+### Example Usage
+
+You can find a example docker compose configuration.
+
+Make sure to update `examples/imap-exporter.env` with your imap credentials.
+
+**Start the example container**
+
+```shell
+pushd examples
+
+docker compose pull
+docker compose up -d
+```
+
 ## License
 
 This project is licensed under the [MIT License](./LICENCE)

diff --git a/examples/docker-compose.yaml b/examples/docker-compose.yaml
@@ -0,0 +1,10 @@
+version: "3"
+
+services:
+
+  imap-exporter:
+    image: "ghcr.io/jop-software/imap-mailbox-exporter:latest"
+    env_file:
+      - "imap-exporter.env"
+    ports:
+      - "9101:9101"
diff --git a/examples/imap-exporter.env b/examples/imap-exporter.env
@@ -0,0 +1,3 @@
+IMAP_SERVER=""
+IMAP_USERNAME=""
+IMAP_PASSWORD=""