chore: publish 3.1.0+25.0.1-fpm release

Adding healthchecks for nginx, mariadb, redis and php-fpm

Co-authored-by: Moritz <moritz.m@local-it.org>
Reviewed-on: coop-cloud/nextcloud#32

.drone.yml

@@ -11,14 +11,22 @@ steps:
       purge: true
       deploy_key:
         from_secret: drone_ssh_swarm_test
+      networks:
+        - proxy
     environment:
       DOMAIN: nextcloud.swarm-test.autonomic.zone
       STACK_NAME: nextcloud
       LETS_ENCRYPT_ENV: production
       ADMIN_USER: foobar
+      FPM_TUNE_VERSION: v1
+      NGINX_CONF_VERSION: v1
+      MY_CNF_VERSION: v1
+      ENTRYPOINT_VERSION: v1
       SECRET_DB_PASSWORD_VERSION: v1
       SECRET_DB_ROOT_PASSWORD_VERSION: v1
       SECRET_ADMIN_PASSWORD_VERSION: v1
+      SECRET_ONLYOFFICE_JWT_VERSION: v1
+      SECRET_BBB_SECRET_VERSION: v1
       EXTRA_VOLUME: "/dev/null:/tmp/.dummy"
 trigger:
   branch:

.env.sample

@@ -1,6 +1,6 @@
 TYPE=nextcloud
 
-DOMAIN={{ .Domain }}
+DOMAIN=nextcloud.example.com
 ## Domain aliases
 #EXTRA_DOMAINS=', `www.nextcloud.example.com`'
 LETS_ENCRYPT_ENV=production
@@ -17,7 +17,37 @@ SECRET_ADMIN_PASSWORD_VERSION=v1
 
 EXTRA_VOLUME=/dev/null:/tmp/.dummy
 
+# fpm-tune, see: https://spot13.com/pmcalculator/
+FPM_MAX_CHILDREN=131
+FPM_START_SERVERS=32
+FPM_MIN_SPARE_SERVERS=32
+FPM_MAX_SPARE_SERVERS=98
+
+DEFAULT_QUOTA="10 GB"
+
 # X_FRAME_OPTIONS_ENABLED=1
 # X_FRAME_OPTIONS_ALLOW_FROM=embedding-site.example.org
-# APPS="calendar sociallogin onlyoffice"
 
+# COMPOSE_FILE="$COMPOSE_FILE:compose.smtp.yml"
+# See https://github.com/nextcloud/docker#auto-configuration-via-environment-variables for default values
+# SMTP_AUTHTYPE=
+# SMTP_HOST=
+# SMTP_SECURE=
+# SMTP_NAME=
+# SMTP_PORT=
+# MAIL_FROM_ADDRESS=
+# MAIL_DOMAIN=
+# SECRET_SMTP_PASSWORD_VERSION=v1
+
+# COMPOSE_FILE="$COMPOSE_FILE:compose.apps.yml"
+# APPS="calendar sociallogin onlyoffice"
+#
+# ONLYOFFICE_URL=https://onlyoffice.example.com
+# SECRET_ONLYOFFICE_JWT_VERSION=v1
+#
+# BBB_URL=https://talk.example.org/bigbluebutton/ # trailing slash!
+# SECRET_BBB_SECRET_VERSION=v1
+#
+# OCC_CMDS="app:disable dashboard"
+# OCC_CMDS="$OCC_CMDS|config:app:set sociallogin auto_create_groups --value 1"
+# OCC_CMDS="$OCC_CMDS|config:app:set sociallogin hide_default_login --value 1"

README.md

@@ -21,9 +21,9 @@ Fully automated luxury Nextcloud via docker-swarm.
 2. Deploy [`coop-cloud/traefik`]
 3. `abra app new nextcloud --secrets` (optionally with `--pass` if you'd like
    to save secrets in `pass`)
-4. `abra app YOURAPPDOMAIN config` - be sure to change `$DOMAIN` to something that resolves to
+4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to
    your Docker swarm box
-5. `abra app YOURAPPDOMAIN deploy`
+5. `abra app deploy YOURAPPDOMAIN`
 
 ## How do I customise the default home page when logging in?
 

abra.sh

@@ -1,22 +1,21 @@
-export FPM_TUNE_VERSION=v4
+#!/bin/bash
+
+export FPM_TUNE_VERSION=v5
 export NGINX_CONF_VERSION=v4
 export MY_CNF_VERSION=v4
-export ENTRYPOINT_VERSION=v2
-
-NC_APP_DIR="app:/var/www/html"
-
-sub_occ(){
-  # shellcheck disable=SC2034
-  abra__service_="app"
-  # shellcheck disable=SC2034
-  abra___user="www-data"
-  sub_app_run php /var/www/html/occ "$@"
-}
+export ENTRYPOINT_VERSION=v3
 
 run_occ(){
     su -p www-data -s /bin/sh -c "/var/www/html/occ $@"
 }
 
+post_install_occ(){
+    IFS='|' read -ra CMD <<< "$OCC_CMDS"
+    for cmd in "${CMD[@]}"; do
+      run_occ "$cmd"
+    done
+}
+
 install_apps(){
     install_apps="$@"
     if [ -z "$install_apps" ]
@@ -29,94 +28,27 @@ install_apps(){
     done
 }
 
-_backup_app() {
-  # Copied _abra_backup_dir to make UX better on restore and backup
-  {
-    abra__src_="$1"
-    abra__dst_="-"
-  }
-
-  # shellcheck disable=SC2154
-  FILENAME="$(basename "$1").tar"
-
-  debug "Copying '$1' to '$FILENAME'"
-
-  silence
-  mkdir -p /tmp/abra
-  sub_app_cp > /tmp/abra/$FILENAME
-  unsilence
+set_app_config(){
+    APP=$1
+    KEY=$2
+    VALUE=$3
+    run_occ "config:app:set $APP $KEY --value $VALUE"
 }
 
-next_maintenance_on() {
-  silence
-  sub_occ maintenance:mode --on > /dev/null
-  unsilence
-  debug "Nextcloud maintenance mode enabled"
+install_bbb(){
+    install_apps bbb
+    set_app_config bbb app.navigation true
+    set_app_config bbb api.url "$BBB_URL"
+    set_app_config bbb api.secret "$(cat /run/secrets/bbb_secret)"
 }
 
-next_maintenance_off() {
-  silence
-  sub_occ maintenance:mode --off > /dev/null
-  unsilence
-  debug "Nextcloud maintenance mode disabled"
+install_onlyoffice(){
+    install_apps onlyoffice
+    set_app_config onlyoffice DocumentServerUrl "$ONLYOFFICE_URL"
+    set_app_config onlyoffice jwt_secret "$(cat /run/secrets/onlyoffice_jwt)"
+    set_app_config onlyoffice customizationForcesave true
 }
 
-abra_backup_app() {
-  # shellcheck disable=SC2154
-  ARK_FILENAME="$ABRA_BACKUP_DIR/${abra__app_}_app_$(date +%F).tar.gz"
-  # Cant be FILENAME as that gets changed by something
-  next_maintenance_on
-  _backup_app $NC_APP_DIR/config
-  _backup_app $NC_APP_DIR/data
-  _backup_app $NC_APP_DIR/themes
-  # Combine archives
-  tar -Af /tmp/abra/config.tar /tmp/abra/data.tar
-  tar -Af /tmp/abra/config.tar /tmp/abra/themes.tar
-  gzip /tmp/abra/config.tar -c > "$ARK_FILENAME"
-  rm /tmp/abra/*.tar
-  success "Backed up 'app' to $ARK_FILENAME"
-  next_maintenance_off
+set_default_quota(){
+    set_app_config files default_quota '"$DEFAULT_QUOTA"'
 }
-
-abra_backup_db() {
-  next_maintenance_on
-  _abra_backup_mysql "db" "nextcloud"
-  next_maintenance_off
-}
-
-abra_backup() {
-  abra_backup_app && abra_backup_db
-}
-
-
-abra_restore_app() {
-  next_maintenance_on
-  # shellcheck disable=SC2034
-  {
-  abra__src_="-"
-  abra__dst_=$NC_APP_DIR
-  }
-
-  zcat "$@" | sub_app_cp
-
-  next_maintenance_off
-  sub_occ files:scan --all > /dev/null # Needs to be run in normal mode
-  success "Restored 'app'"
-}
-
-# abra_restore_db() {
-#   warning "Restoring the database is on a existing app and not a new one has not been tested. Use with caution."
-#   next_maintenance_on
-#   # 3wc: unlike abra_backup_db, we can assume abra__service_ will be 'db' if we
-#   # got this far..
-
-#   # shellcheck disable=SC2034
-#   abra___no_tty="true"
-
-#   DB_PASSWORD=$(sub_app_run cat /run/secrets/db_password)
-
-#   zcat "$@" | sub_app_run mysql -u root -p"$DB_PASSWORD" wordpress
-
-#   success "Restored 'db'"
-#   next_maintenance_off
-# }

compose.apps.yml

@@ -0,0 +1,18 @@
+version: "3.8"
+services:
+  app:
+    secrets:
+      - onlyoffice_jwt
+      - bbb_secret
+    environment:
+      - APPS
+      - ONLYOFFICE_URL
+      - BBB_URL
+
+secrets:
+  onlyoffice_jwt:
+    external: true
+    name: ${STACK_NAME}_onlyoffice_jwt_${SECRET_ONLYOFFICE_JWT_VERSION}
+  bbb_secret:
+    external: true
+    name: ${STACK_NAME}_bbb_secret_${SECRET_BBB_SECRET_VERSION}

compose.mariadb.yml

@@ -31,6 +31,12 @@ services:
           backupbot.backup.pre-hook: 'mkdir -p /tmp/backup/ && mysqldump --single-transaction -u root -p"$$(cat /run/secrets/db_root_password)" nextcloud > /tmp/backup/backup.sql'
           backupbot.backup.post-hook: "rm -rf /tmp/backup"
           backupbot.backup.path: "/tmp/backup/"
+    healthcheck:
+      test: ["CMD-SHELL", 'mysqladmin -p"$$(cat /run/secrets/db_root_password)"  ping']
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
 configs:
   my_tune:
     name: ${STACK_NAME}_my_cnf_${MY_CNF_VERSION}

compose.smtp.yml

@@ -0,0 +1,19 @@
+version: "3.8"
+services:
+  app:
+    secrets:
+      - smtp_password
+    environment:
+      - SMTP_AUTHTYPE
+      - SMTP_HOST
+      - SMTP_SECURE
+      - SMTP_NAME
+      - SMTP_PORT
+      - SMTP_PASSWORD_FILE=/run/secrets/smtp_password
+      - MAIL_FROM_ADDRESS
+      - MAIL_DOMAIN
+
+secrets:
+  smtp_password:
+    external: true
+    name: ${STACK_NAME}_smtp_password_${SECRET_SMTP_PASSWORD_VERSION}

compose.yml

@@ -1,7 +1,7 @@
 version: "3.8"
 services:
   web:
-    image: nginx:1.23.1
+    image: nginx:1.23.2
     configs:
       - source: nginx_conf
         target: /etc/nginx/nginx.conf
@@ -33,9 +33,15 @@ 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}"
+    healthcheck:
+      test: ["CMD-SHELL", 'curl -s -N curl -Ns localhost/status.php |  grep "installed\":true"']
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
 
   app:
-    image: nextcloud:24.0.6-fpm
+    image: nextcloud:25.0.1-fpm
     depends_on:
       - db
     configs:
@@ -50,6 +56,7 @@ services:
       - admin_password
     environment:
       - APPS
+      - OCC_CMDS
       - X_FRAME_OPTIONS_ALLOW_FROM
       - X_FRAME_OPTIONS_ENABLED
       - DOMAIN
@@ -59,12 +66,13 @@ services:
       - NEXTCLOUD_TRUSTED_DOMAINS=${DOMAIN}
       - TRUSTED_PROXIES=traefik
       - REDIS_HOST=cache
-      - SMTP_HOST
-      - MAIL_FROM_ADDRESS
-      - MAIL_DOMAIN
-      - SMTP_AUTHTYPE=PLAIN
       - OVERWRITEPROTOCOL=https
       - PHP_MEMORY_LIMIT=1G
+      - FPM_MAX_CHILDREN=131
+      - FPM_START_SERVERS=32
+      - FPM_MIN_SPARE_SERVERS=32
+      - FPM_MAX_SPARE_SERVERS=98
+      - DEFAULT_QUOTA
     volumes:
       - nextcloud:/var/www/html/
       - nextapps:/var/www/html/custom_apps:cached
@@ -78,12 +86,18 @@ services:
         failure_action: rollback
         order: start-first
       labels:
-        - "coop-cloud.${STACK_NAME}.version=2.1.4+24.0.6-fpm"
+        - "coop-cloud.${STACK_NAME}.version=3.1.0+25.0.1-fpm"
         - "backupbot.backup=true"
         - "backupbot.backup.path=/var/www/html/config/,/var/www/html/data/,/var/www/html/custom_apps/"
+    healthcheck:
+      test: ["CMD-SHELL", 'SCRIPT_NAME=status SCRIPT_FILENAME=/var/www/html/status.php REQUEST_METHOD=GET cgi-fcgi -bind -connect 127.0.0.1:9000 | grep "installed\":true"']
+      interval: 30s
+      timeout: 10s
+      retries: 10
+      start_period: 1m
 
   cron:
-    image: nextcloud:24.0.6-fpm
+    image: nextcloud:25.0.1-fpm
     volumes:
       - nextcloud:/var/www/html/
       - nextapps:/var/www/html/custom_apps:cached
@@ -100,6 +114,11 @@ services:
       - internal
     volumes:
       - "redis:/data"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 3s
+      timeout: 5s
+      retries: 20
 
 secrets:
   db_root_password:
@@ -107,7 +126,7 @@ secrets:
     name: ${STACK_NAME}_db_root_password_${SECRET_DB_ROOT_PASSWORD_VERSION}
   db_password:
     external: true
-    name: ${STACK_NAME}_db_password_${SECRET_DB_ROOT_PASSWORD_VERSION}
+    name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
   admin_password:
     external: true
     name: ${STACK_NAME}_admin_password_${SECRET_ADMIN_PASSWORD_VERSION}
@@ -128,6 +147,7 @@ configs:
   fpm_tune:
     name: ${STACK_NAME}_fpm_tune_${FPM_TUNE_VERSION}
     file: fpm-tune.ini
+    template_driver: golang
   entrypoint:
     name: ${STACK_NAME}_entrypoint_${ENTRYPOINT_VERSION}
     file: entrypoint.sh.tmpl

entrypoint.sh.tmpl

@@ -1,5 +1,30 @@
 #!/bin/bash
 
+set -eu
+
+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 "SMTP_PASSWORD"
+
 echo "Giving the db container some time to come up"; sleep 20
 # see this issue with postgres db https://github.com/nextcloud/docker/issues/1204
 
@@ -9,4 +34,8 @@ if ! [[ $(grep {{ env "X_FRAME_OPTIONS_ALLOW_FROM" }} lib/public/AppFramework/Ht
 fi
 {{ end }}
 
+# Required for healthcheck
+which cgi-fcgi > /dev/null || (apt-get update && apt-get install -y libfcgi-bin)
+
+
 /entrypoint.sh php-fpm

fpm-tune.ini

@@ -1,5 +1,5 @@
 pm = dynamic
-pm.max_children = 131
-pm.start_servers = 32
-pm.min_spare_servers = 32
-pm.max_spare_servers = 98
+pm.max_children = {{ env "FPM_MAX_CHILDREN" }}
+pm.start_servers = {{ env "FPM_START_SERVERS" }}
+pm.min_spare_servers = {{ env "FPM_MIN_SPARE_SERVERS" }}
+pm.max_spare_servers = {{ env "FPM_MAX_SPARE_SERVERS" }}

releases/3.1.0+25.0.1-fpm

@@ -0,0 +1,57 @@
+
+## FPM Tune
+
+The fpm-tune.ini settings are now configurable by `.env`. Please add this to your servers configs:
+
+```
+# fpm-tune, see: https://spot13.com/pmcalculator/
+FPM_MAX_CHILDREN=131
+FPM_START_SERVERS=32
+FPM_MIN_SPARE_SERVERS=32
+FPM_MAX_SPARE_SERVERS=98
+```
+
+## SMTP
+
+Add SMTP Config to your .env file:
+
+```
+# COMPOSE_FILE="$COMPOSE_FILE:compose.smtp.yml"
+# See https://github.com/nextcloud/docker#auto-configuration-via-environment-variables for default values
+# SMTP_AUTHTYPE=
+# SMTP_HOST=
+# SMTP_SECURE=
+# SMTP_NAME=
+# SMTP_PORT=
+# MAIL_FROM_ADDRESS=
+# MAIL_DOMAIN=
+# SECRET_SMTP_PASSWORD_VERSION=v1
+abra app secret insert example.com smtp_password v1 example_password
+```
+
+
+## Post Deploy Commands
+
+Some Apps can also be managed with abra app cmd!
+
+```
+# COMPOSE_FILE="$COMPOSE_FILE:compose.apps.yml"
+# APPS="calendar sociallogin onlyoffice"
+abra app cmd example.com app install_apps
+# ONLYOFFICE_URL=https://onlyoffice.example.com
+# SECRET_ONLYOFFICE_JWT_VERSION=v1
+abra app secret insert example.com onlyoffice_jwt v1 example_password
+abra app cmd example.com app install_onlyoffice
+# BBB_URL=https://talk.example.org/bigbluebutton/ # trailing slash!
+# SECRET_BBB_SECRET_VERSION=v1
+abra app secret insert example.com bbb_secret v1 example_password
+abra app cmd example.com app install_bbb
+```
+
+## Set Quota
+
+```
+# DEFAULT_QUOTA="10 GB"
+abra app cmd example.com app set_default_quota
+```
+