Merge pull request 'Added backup flags to compose.yml' (#4) from bb2-backups into main

Reviewed-on: #4

.drone.yml

@@ -32,7 +32,7 @@ steps:
         from_secret: drone_abra-bot_token
       fork: true
       repositories:
-        - coop-cloud/auto-recipes-catalogue-json
+        - toolshed/auto-recipes-catalogue-json
 
 trigger:
   event: tag

.env.sample

@@ -1,8 +1,15 @@
 TYPE=uptime-kuma
+COMPOSE_FILE="compose.yml"
+LETS_ENCRYPT_ENV=production
 
 DOMAIN=uptime-kuma.example.com
 
 ## Domain aliases
 #EXTRA_DOMAINS=', `www.uptime-kuma.example.com`'
 
-LETS_ENCRYPT_ENV=production
+SECRET_DB_PASSWORD_VERSION=v1
+SECRET_DB_ROOT_PASSWORD_VERSION=v1
+
+
+## Enable mariadb
+#COMPOSE_FILE="$COMPOSE_FILE:compose.mariadb.yml"

README.md

@@ -8,7 +8,7 @@
 * **Status**: 0
 * **Image**: [`uptime-kuma`](https://hub.docker.com/r/uptime-kuma), 4, upstream
 * **Healthcheck**: No
-* **Backups**: No
+* **Backups**: Yes
 * **Email**: No
 * **Tests**: No
 * **SSO**: No
@@ -22,3 +22,10 @@
 * `abra app deploy <app-name>`
 
 For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
+
+## MariaDB
+
+By default uptime-kuma uses a sqlite database. It is possible to switch to a mariadb:
+```
+#COMPOSE_FILE="$COMPOSE_FILE:compose.mariadb.yml"
+```

abra.sh

@@ -0,0 +1,5 @@
+export APP_ENTRYPOINT_VERSION=v2
+
+get_all_urls() {
+  echo "select url from monitor" | mariadb -u kuma -p$(cat /run/secrets/db_password) -D kuma | sed 's|https://||' | sed 's|/.*||' | sort
+}

compose.mariadb.yml

@@ -0,0 +1,43 @@
+---
+version: "3.8"
+
+services:
+  app:
+    secrets:
+      - db_password
+    environment:
+      - UPTIME_KUMA_GH_REPO=louislam:uptime-kuma
+      - UPTIME_KUMA_DB_TYPE=mariadb
+      - UPTIME_KUMA_DB_HOSTNAME=db
+      - UPTIME_KUMA_DB_PORT=3306
+      - UPTIME_KUMA_DB_NAME=kuma
+      - UPTIME_KUMA_DB_USERNAME=kuma
+      - UPTIME_KUMA_DB_PASSWORD_FILE=/run/secrets/db_password
+    depends_on:
+      - db
+
+  db:
+    image: mariadb:11.7
+    environment:
+      - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/db_root_password
+      - MYSQL_PASSWORD_FILE=/run/secrets/db_password
+      - MYSQL_USER=kuma
+      - MYSQL_DATABASE=kuma
+    volumes:
+      - mariadb:/var/lib/mysql
+    networks:
+      - internal
+    secrets:
+      - db_password
+      - db_root_password
+
+volumes:
+  mariadb:
+
+secrets:
+  db_password:
+    external: true
+    name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
+  db_root_password:
+    external: true
+    name: ${STACK_NAME}_db_root_password_${SECRET_DB_ROOT_PASSWORD_VERSION}

compose.yml

@@ -3,11 +3,24 @@ version: "3.8"
 
 services:
   app:
-    image: louislam/uptime-kuma:1.23.11
+    image: louislam/uptime-kuma:2.0.0-beta.1
     volumes:
       - data:/app/data
+    secrets:
+      - db_password
     networks:
+      - internal
       - proxy
+    environment:
+      - UPTIME_KUMA_GH_REPO=louislam:uptime-kuma
+      - UPTIME_KUMA_DB_TYPE=sqlite
+    depends_on:
+      - db
+    configs:
+      - source: app_entrypoint
+        target: /docker-entrypoint.sh
+        mode: 0555
+    entrypoint: /docker-entrypoint.sh
     deploy:
       update_config:
         failure_action: rollback
@@ -22,17 +35,53 @@ services:
         #- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
         #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
         #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
-        - "coop-cloud.${STACK_NAME}.version=0.5.0+1.23.11"
+        - "coop-cloud.${STACK_NAME}.version=2.0.0+2.0.0-beta.1"
     healthcheck:
-      test: 'curl -L localhost:3001'
+      test: "curl -L localhost:3001"
       interval: 30s
       timeout: 10s 
       retries: 5 
       start_period: 2m
+  db:
+    image: mariadb:11.7
+    environment:
+      - MYSQL_ROOT_PASSWORD_FILE=/run/secrets/db_root_password
+      - MYSQL_PASSWORD_FILE=/run/secrets/db_password
+      - MYSQL_USER=kuma
+      - MYSQL_DATABASE=kuma
+    volumes:
+      - mariadb:/var/lib/mysql
+    networks:
+      - internal
+    secrets:
+      - db_password
+      - db_root_password
+    deploy:
+      labels:
+        backupbot.backup: "${ENABLE_BACKUPS:-true}"
+        backupbot.backup.pre-hook: "mariadb-dump --single-transaction -u root -p\"$$(cat /run/secrets/db_root_password)\" kuma | gzip > /var/lib/mysql/dump.sql.gz"
+        backupbot.backup.volumes.mariadb.path: "dump.sql.gz"
+        backupbot.restore.post-hook: "gzip -d /var/lib/mysql/dump.sql.gz && mariadb -u root -p\"$$(cat /run/secrets/db_root_password)\" kuma < /var/lib/mysql/dump.sql && rm -f /var/lib/mysql/dump.sql"
 
 volumes:
+  mariadb:
   data:
 
 networks:
   proxy:
     external: true
+  internal:
+
+secrets:
+  db_password:
+    external: true
+    name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
+  db_root_password:
+    external: true
+    name: ${STACK_NAME}_db_root_password_${SECRET_DB_ROOT_PASSWORD_VERSION}
+
+configs:
+  app_entrypoint:
+    name: ${STACK_NAME}_app_entrypoint_${APP_ENTRYPOINT_VERSION}
+    file: entrypoint.sh.tmpl
+    template_driver: golang

entrypoint.sh.tmpl

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -e
+
+file_env() {
+   local var="$1"
+   local fileVar="${var}_FILE"
+   local def="${2:-}"
+
+   if [ "${!var:-}" ] && [ "${!fileVar:-}" ]; then
+      echo >&2 "error: both $var and $fileVar are set (but are exclusive)"
+      exit 1
+   fi
+
+   local val="$def"
+
+   if [ "${!var:-}" ]; then
+      val="${!var}"
+   elif [ "${!fileVar:-}" ]; then
+      val="$(< "${!fileVar}")"
+   fi
+
+   export "$var"="$val"
+   unset "$fileVar"
+}
+
+file_env "UPTIME_KUMA_DB_PASSWORD"
+
+# upstream startup command
+cd /app
+node server/server.js

release/1.0.0+latest

@@ -0,0 +1,29 @@
+!!BREAKING CHANGE!!
+
+this version is using self-built docker image for uptime kuma to incorporate mariadb which is not officially supported yet. Performance with sqlite was really bad and uptime kuma became unusable at some point. Upgrading to this version requires manually exporting sqlite database and converting it to mariadb. Additionally there's been changes to the database structure between last published version in this so it's not enough to just export the tables, you actually need to add a bunch of fields. And importing groups and other tables is a big hassle, better stick to just `monitor`...
+
+Here's some python to help you with this.
+
+```
+#!/usr/bin/python3
+
+og = open("original.sql", "r")
+new = open("ported.sql", "w")
+
+for line in og:
+    newline = line
+    if line.startswith("INSERT INTO monitor VALUES"):
+        newarr = line[27:-3].split(",")
+        if len(newarr) == 77:
+            kafka_producer_ssl_and_topic = ["0", "0"]
+            arr = newarr[:66] + kafka_producer_ssl_and_topic + newarr[66:75] + ["'keyword'", "NULL", "NULL", "'2c'", "NULL", "0", "'{}'"]
+            newline = "INSERT INTO monitor VALUES(" + ",".join(arr) + ");\n"
+        else:
+            newline = "--" + line
+    else:
+        pass
+    new.writelines(newline) 
+
+og.close()
+new.close()
+```

release/2.0.0+2.0.0-beta.1

@@ -0,0 +1 @@
+sqlite is the default database now, check the README.md on how to configure mariadb

release/convertmonitor.py

@@ -0,0 +1,21 @@
+#!/usr/bin/python3
+
+og = open("original.sql", "r")
+new = open("ported.sql", "w")
+
+for line in og:
+    newline = line
+    if line.startswith("INSERT INTO monitor VALUES"):
+        newarr = line[27:-3].split(",")
+        if len(newarr) == 77:
+            kafka_producer_ssl_and_topic = ["0", "0"]
+            arr = newarr[:66] + kafka_producer_ssl_and_topic + newarr[66:75] + ["'keyword'", "NULL", "NULL", "'2c'", "NULL", "0", "'{}'"]
+            newline = "INSERT INTO monitor VALUES(" + ",".join(arr) + ");\n"
+        else:
+            newline = "--" + line
+    else:
+        pass
+    new.writelines(newline) 
+
+og.close()
+new.close()