From 98d2ff2a0a2892bcc2a3eace3cd65d9cc2856f78 Mon Sep 17 00:00:00 2001
From: BroodjeAap <david@broodjeaap.net>
Date: Fri, 6 Jan 2023 11:28:33 +0000
Subject: [PATCH] added compose templates to docs

---
 README.md                                     |  6 ++++
 .../apprise-browserless-postgresql.yml        | 36 +++++++++++++++++++
 ...rowserless.yml => apprise-browserless.yml} |  0
 ...docker-compose-apprise.yml => apprise.yml} |  0
 .../{docker-compose-auth.yml => auth.yml}     |  0
 docs/compose/browserless.yml                  | 17 +++++++++
 ...-compose-postgresql.yml => postgresql.yml} |  0
 todo.md                                       | 10 +-----
 8 files changed, 60 insertions(+), 9 deletions(-)
 create mode 100644 docs/compose/apprise-browserless-postgresql.yml
 rename docs/compose/{docker-compose-browserless.yml => apprise-browserless.yml} (100%)
 rename docs/compose/{docker-compose-apprise.yml => apprise.yml} (100%)
 rename docs/compose/{docker-compose-auth.yml => auth.yml} (100%)
 create mode 100644 docs/compose/browserless.yml
 rename docs/compose/{docker-compose-postgresql.yml => postgresql.yml} (100%)

diff --git a/README.md b/README.md
index f1288ef..9f00d9f 100644
--- a/README.md
+++ b/README.md
@@ -231,6 +231,12 @@ services:
 
 Change the `Host` label to the correct ip/hostname and generate a user/password string with [htpasswd](https://httpd.apache.org/docs/2.4/programs/htpasswd.html) for the `basicauth.users` label, note that the `$` character is escaped with `$$`
 
+### Compose templates
+
+There are a few docker-compose templates in the [docs/compose](docs/compose/) directory that can downloaded and used as starting points.  
+For example, if you want to set up GoWatch with Browserless, Apprise and a PostgreSQL database backend:  
+`wget https://raw.githubusercontent.com/broodjeaap/go-watch/master/docs/compose/apprise-browserless-postgresql.yml -O ./docker-compose.yml`
+
 # Filters
 
 GoWatch comes with many filters that should, hopefully, be enough to allow for most use cases.  
diff --git a/docs/compose/apprise-browserless-postgresql.yml b/docs/compose/apprise-browserless-postgresql.yml
new file mode 100644
index 0000000..ae13143
--- /dev/null
+++ b/docs/compose/apprise-browserless-postgresql.yml
@@ -0,0 +1,36 @@
+version: "3"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: base
+    container_name: go-watch
+    environment:
+    - GOWATCH_BROWSERLESS_URL=http://browserless:3000/content
+    volumes:
+    - /host/path/to/config:/config
+    ports:
+    - "8080:8080"
+    depends_on:
+      db:
+        condition: service_healthy
+  db:
+    image: postgres:15
+    environment:
+    - POSTGRES_USER=gorm
+    - POSTGRES_PASSWORD=gorm
+    - POSTGRES_DB=gorm
+    volumes:
+    - /host/path/to/db:/var/lib/postgresql/data
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+  apprise:
+    image: caronc/apprise:latest
+  browserless:
+    image: browserless/chrome:latest
+  
\ No newline at end of file
diff --git a/docs/compose/docker-compose-browserless.yml b/docs/compose/apprise-browserless.yml
similarity index 100%
rename from docs/compose/docker-compose-browserless.yml
rename to docs/compose/apprise-browserless.yml
diff --git a/docs/compose/docker-compose-apprise.yml b/docs/compose/apprise.yml
similarity index 100%
rename from docs/compose/docker-compose-apprise.yml
rename to docs/compose/apprise.yml
diff --git a/docs/compose/docker-compose-auth.yml b/docs/compose/auth.yml
similarity index 100%
rename from docs/compose/docker-compose-auth.yml
rename to docs/compose/auth.yml
diff --git a/docs/compose/browserless.yml b/docs/compose/browserless.yml
new file mode 100644
index 0000000..567b882
--- /dev/null
+++ b/docs/compose/browserless.yml
@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: base
+    container_name: go-watch
+    environment:
+    - GOWATCH_BROWSERLESS_URL=http://browserless:3000/content
+    volumes:
+    - /host/path/to/config:/config
+    ports:
+    - "8080:8080"
+  browserless:
+    image: browserless/chrome:latest
\ No newline at end of file
diff --git a/docs/compose/docker-compose-postgresql.yml b/docs/compose/postgresql.yml
similarity index 100%
rename from docs/compose/docker-compose-postgresql.yml
rename to docs/compose/postgresql.yml
diff --git a/todo.md b/todo.md
index 2671279..4b0a372 100644
--- a/todo.md
+++ b/todo.md
@@ -1,11 +1,3 @@
 # Todo
 - comments
-- add compose templates for:
-    - sqlite
-    - sqlite+apprise
-    - sqlite+apprise+browserless
-    - postgresql
-    - postgresql+apprise
-    - postgresql+apprise+browserless
-- add kube yaml example?
-- organize docs?
\ No newline at end of file
+- add kube yaml example?
\ No newline at end of file