adds maintenance and updates readme

local.json is automatically generated and can change due to updates,
to prevent breaking changes, only append the necssary config
using a custom entrypoint.

.drone.yml

@@ -17,8 +17,9 @@ steps:
       DOMAIN: onlyoffice.swarm-test.autonomic.zone
       STACK_NAME: onlyoffice
       LETS_ENCRYPT_ENV: production
-      LOCAL_JSON_VERSION: v1
+      ENTRYPOINT_VERSION: v1
       SECRET_DB_PASSWORD_VERSION: v1
+      PG_BACKUP_VERSION: v2
 trigger:
   branch:
     - main
@@ -34,7 +35,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,5 +1,8 @@
 TYPE=onlyoffice
+#TIMEOUT=300
+ENABLE_AUTO_UPDATE=true
 LETS_ENCRYPT_ENV=production
+ENABLE_BACKUPS=true
 DOMAIN=onlyoffice.example.com
 
 SECRET_DB_PASSWORD_VERSION=v1

MAINTENANCE.md

@@ -0,0 +1,32 @@
+# OnlyOffice Recipe Maintenance
+
+All contributions should be made via a pull request. This is to ensure a
+certain quality and consistency, that others can rely on.
+
+## Maintainer Responsibilities
+
+A recipe maintainer has the following responsibilities:
+
+- Respond to pull requests / issues within two weeks
+- Make image security updates within a week
+- Make image major updates every three months
+
+In order to fullfill these responsibilities a recipe maintainer:
+
+- Has to watch the repository (to get notifications)
+- Needs to make sure renovate is configured properly
+
+## Pull Requests
+
+A pull request can be merged if it is approved by at least one maintainer. For
+pull requests opened by a maintainer they need to be approved by another
+maintainer. Even though it is okay to merge a pull request with one approval, it
+is always better if all maintainers looked at the pull request and approved it.
+
+## Become a maintainer
+
+Everyone can apply to be a recipe maintainer:
+1. Watch the repository to always get updates
+2. Simply add your self to the list in the [README.md](./README.md) and open a new pull request with the change.
+3. Once the pull request gets merged you will be added to the [onlyoffice maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/onlyoffice-maintainers).
+4. Join the room [#cc-|-onlyoffice-maintenance:matrix.org](#cc-|-onlyoffice-maintenance:matrix.org) and chat to other maintainers.

README.md

@@ -3,21 +3,30 @@
 [![Build Status](https://drone.autonomic.zone/api/badges/coop-cloud/onlyoffice/status.svg?ref=refs/heads/main)](https://drone.autonomic.zone/coop-cloud/onlyoffice)
 
 <!-- metadata -->
-
+* **Maintainer**: Local-IT: [@moritz](https://git.coopcloud.tech/moritz), [@msimon](https://git.coopcloud.tech/simon), [@carla](https://git.coopcloud.tech/carla)
 * **Category**: Apps
 * **Status**: 3, stable
 * **Image**: [`onlyoffice`](https://hub.docker.com/r/onlyoffice/documentserver/), 4, upstream
-* **Healthcheck**: No
+* **Healthcheck**: Yes
 * **Backups**: No
-* **Email**: 3
+* **Email**: N/A
 * **Tests**: 2
 * **SSO**: No
 <!-- endmetadata -->
 
 ## Basic usage
 
-1. Set up Docker Swarm and [`abra`](https://git.autonomic.zone/coop-cloud/abra)
-1. Deploy [`coop-cloud/traefik`](https://git.autonomic.zone/coop-cloud/traefik)
-1. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to
-   your Docker swarm box
-1. `abra app deploy YOURAPPDOMAIN`
+* `abra app new onlyoffice`
+* `abra app config <app-name>`
+    - uncomment `COMPOSE_FILE` and `SECRET_JWT_SECRET_VERSION` to enable JWT Secret
+* `abra app secret generate -a <app-name>`
+* `abra app deploy <app-name>`
+
+
+For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech) and [`ONLYOFFICE/Docker-DocumentServer`](https://github.com/ONLYOFFICE/Docker-DocumentServer).
+[Official Onlyoffice docker compose](https://github.com/ONLYOFFICE/Docker-DocumentServer/blob/master/docker-compose.yml)
+
+## Add custom fonts
+Per default the config parameter for **GENERATE_FONT** is set to *true*, so fonts list and the fonts thumbnails are regenerated at each start. To add additional fonts you can copy them via abra to the volume `/usr/share/fonts/truetype` and restart the service:
+* `abra app cp 123.net calibri-regular.ttf app:/usr/share/fonts/truetype`
+* `abra app restart office.tmp.dev.local-it.cloud service app`

abra.sh

@@ -1,4 +1,5 @@
-export LOCAL_JSON_VERSION=v1
+export ENTRYPOINT_VERSION=v1
+export PG_BACKUP_VERSION=v2
 
 prepare_shutdown () {
   documentserver-prepare4shutdown.sh    

alaconnect.yml

@@ -0,0 +1,6 @@
+nextcloud:
+    uncomment:
+        - compose.jwt.yml
+        - SECRET_JWT_SECRET_VERSION
+    shared_secrets:
+        onlyoffice_jwt: jwt_secret

compose.jwt.yml

@@ -5,6 +5,7 @@ services:
       - JWT_ENABLED=true
       - JWT_HEADER=Authorization
       - JWT_IN_BODY=true
+      - JWT_SECRET_FILE=/run/secrets/jwt_secret
     secrets:
       - jwt_secret
 

compose.yml

@@ -1,24 +1,27 @@
-version: '3.8'
+version: "3.8"
 services:
   app:
-    image: onlyoffice/documentserver:7.2.2
+    image: onlyoffice/documentserver:9.4.0
     depends_on:
       - db
       - rabbitmq
     stdin_open: true
     networks:
       - proxy
-      - internal 
+      - internal
     environment:
       DB_TYPE: postgres
       DB_HOST: db
       DB_PORT: 5432
       DB_NAME: onlyoffice
       DB_USER: onlyoffice
+      DB_PWD_FILE: /run/secrets/db_password
       AMQP_URI: amqp://guest:guest@rabbitmq
-      AUTO_ASSEMBLY_ENABLED: 
-      AUTO_ASSEMBLY_INTERVAL: 
-      AUTO_ASSEMBLY_STEP: 
+      AUTO_ASSEMBLY_ENABLED:
+      AUTO_ASSEMBLY_INTERVAL:
+      AUTO_ASSEMBLY_STEP:
+    volumes:
+      - fonts:/usr/share/fonts/truetype
     secrets:
       - db_password
     healthcheck:
@@ -28,25 +31,28 @@ services:
       retries: 10
       start_period: 1m
     configs:
-      - source: local_json
-        target: /etc/onlyoffice/documentserver/local.json
+      - source: entrypoint
+        target: /custom-entrypoint.sh
+        mode: 555
+    entrypoint: /custom-entrypoint.sh
     deploy:
       update_config:
         failure_action: rollback
         order: start-first
       labels:
+        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT}"
         - "traefik.enable=true"
-        - "traefik.docker.network=proxy"
+        - "traefik.swarm.network=proxy"
         - "traefik.http.services.${STACK_NAME}.loadbalancer.server.port=80"
         - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`)"
         - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
         - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
         - "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-fwdproto"
         - "traefik.http.middlewares.${STACK_NAME}-fwdproto.headers.customRequestHeaders.X-Forwarded-Proto=https"
-        - "coop-cloud.${STACK_NAME}.version=2.3.0+7.2.2"
-        
+        - "coop-cloud.${STACK_NAME}.version=2.13.0+9.4.0"
+
   rabbitmq:
-    image: rabbitmq:3.11.7
+    image: rabbitmq:4.3.2
     networks:
       - internal
     healthcheck:
@@ -55,9 +61,15 @@ services:
       timeout: 10s
       retries: 10
       start_period: 1m
-    
+
   db:
     image: postgres:9.5
+    deploy:
+      labels:
+        backupbot.backup: "${ENABLE_BACKUPS:-true}"
+        backupbot.backup.pre-hook: "/pg_backup.sh backup"
+        backupbot.backup.volumes.db.path: "backup.sql"
+        backupbot.restore.post-hook: "/pg_backup.sh restore"
     environment:
       POSTGRES_DB: onlyoffice
       POSTGRES_USER: onlyoffice
@@ -69,14 +81,19 @@ services:
     networks:
       - internal
     healthcheck:
-      test: ["CMD", "pg_isready"]
+      test: ["CMD", "pg_isready", "-U", "onlyoffice"]
       interval: 30s
       timeout: 10s
       retries: 10
       start_period: 1m
+    configs:
+      - source: pg_backup
+        target: /pg_backup.sh
+        mode: 0555
 
 volumes:
   db:
+  fonts:
 
 networks:
   proxy:
@@ -89,8 +106,10 @@ secrets:
     name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
 
 configs:
-  local_json:
-    name: ${STACK_NAME}_local_json_${LOCAL_JSON_VERSION}
-    file: local.json.tmpl 
+  entrypoint:
+    name: ${STACK_NAME}_entrypoint_${ENTRYPOINT_VERSION}
+    file: entrypoint.sh.tmpl
     template_driver: golang
-
+  pg_backup:
+    name: ${STACK_NAME}_pg_backup_${PG_BACKUP_VERSION}
+    file: pg_backup.sh

entrypoint.sh.tmpl

@@ -0,0 +1,37 @@
+#!/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 "DB_PWD"
+file_env "JWT_SECRET"
+
+CONFIG=/etc/onlyoffice/documentserver/local.json
+JSON_BIN=/var/www/onlyoffice/documentserver/npm/json
+JSON="${JSON_BIN} -q -f ${CONFIG}"
+${JSON} -I -e "if(this.services.CoAuthoring.autoAssembly===undefined)this.services.CoAuthoring.autoAssembly={};"
+${JSON} -I -e "this.services.CoAuthoring.autoAssembly.enable = ${AUTO_ASSEMBLY_ENABLED}"
+${JSON} -I -e "this.services.CoAuthoring.autoAssembly.interval = '${AUTO_ASSEMBLY_INTERVAL}'"
+${JSON} -I -e "this.services.CoAuthoring.autoAssembly.step = '${AUTO_ASSEMBLY_STEP}'"
+
+/app/ds/run-document-server.sh

local.json.tmpl

@@ -1,55 +0,0 @@
-{
-  "services": {
-    "CoAuthoring": {
-      "sql": {
-       "type": "{{ env "DB_TYPE" }}",
-        "dbHost": "{{ env "DB_HOST" }}",
-        "dbPort": "{{ env "DB_PORT" }}",
-        "dbName": "{{ env "DB_NAME" }}",
-        "dbUser": "{{ env "DB_USER" }}",
-        "dbPass": "{{ secret  "db_password" }}"
-      },
-  {{ if eq (env "JWT_ENABLED") "true" }}
-      "token": {
-        "enable": {
-          "request": {
-            "inbox": true,
-            "outbox": true
-          },
-          "browser": true
-        },
-        "inbox": {
-          "header": "Authorization",
-          "inBody": true
-        },
-        "outbox": {
-          "header": "Authorization",
-          "inBody": true
-        }
-      },
-      "secret": {
-        "inbox": {
-          "string": "{{ secret "jwt_secret" }}"
-        },
-        "outbox": {
-          "string": "{{ secret "jwt_secret" }}"
-        },
-        "session": {
-          "string": "{{ secret "jwt_secret" }}"
-        }
-      },
-    {{ end }}
-    "autoAssembly" : {
-      "enable": {{ env "AUTO_ASSEMBLY_ENABLED" }},
-      "interval": "{{ env "AUTO_ASSEMBLY_INTERVAL" }}",
-      "step": "{{ env "AUTO_ASSEMBLY_STEP" }}"
-      }
-    }
-  },
-  "rabbitmq": {
-    "url": "amqp://guest:guest@rabbitmq"
-  },
-  "queue": {
-    "type": "rabbitmq"
-  }
-}

pg_backup.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+set -e
+
+BACKUP_FILE='/var/lib/postgresql/data/backup.sql'
+
+function backup {
+  export PGPASSWORD=$(cat /run/secrets/db_password)
+  pg_dump -U ${POSTGRES_USER} ${POSTGRES_DB} > $BACKUP_FILE
+}
+
+function restore {
+    cd /var/lib/postgresql/data/
+    restore_config(){
+        # Restore allowed connections
+        cat pg_hba.conf.bak > pg_hba.conf
+        su postgres -c 'pg_ctl reload'
+    }
+    # Don't allow any other connections than local
+    cp pg_hba.conf pg_hba.conf.bak
+    echo "local all all trust" > pg_hba.conf
+    su postgres -c 'pg_ctl reload'
+    trap restore_config EXIT INT TERM
+
+    # Recreate Database
+    psql -U ${POSTGRES_USER} -d postgres -c "DROP DATABASE ${POSTGRES_DB} WITH (FORCE);" 
+    createdb -U ${POSTGRES_USER} ${POSTGRES_DB}
+    psql -U ${POSTGRES_USER} -d ${POSTGRES_DB} -1 -f $BACKUP_FILE
+
+    trap - EXIT INT TERM
+    restore_config
+}
+
+$@