Revert "Change onlyoffice to euro-office"

This reverts commit 475f995.

Author: mrmarkuz

.github/workflows/clean-registry.yml

@@ -15,5 +15,5 @@ jobs:
     steps:
       - uses: NethServer/ns8-github-actions/.github/actions/delete-image@v1
         with:
-          images: "euro-office"
+          images: "onlyoffice"
           delete_image_token: ${{ secrets.IMAGES_CLEANUP_TOKEN }}

README.md

@@ -1,60 +1,70 @@
-# ns8-euro-office
+# ns8-onlyoffice
 
-This is the Euro-Office app for NethServer 8.
+This is the Onlyoffice app for NethServer 8.
 
 ## Install
 
 Install via Software center:
 
   - Add a Software repository pointing to `https://repo.mrmarkuz.com/ns8/updates/`, check out the [repo webpage](https://repo.mrmarkuz.com) how to do it.
-  - Install Euro-Office via Software Center
+  - Install Onlyoffice via Software Center
 
 Instantiate the module on CLI with:
 
-    add-module ghcr.io/mrmarkuz/euro-office:latest 1
+    add-module ghcr.io/mrmarkuz/onlyoffice:latest 1
 
 The output of the command will return the instance name.
 Output example:
 
-    {"module_id": "euro-office1", "image_name": "euro-office", "image_url": "ghcr.io/mrmarkuz/euro-office:latest"}
+    {"module_id": "onlyoffice1", "image_name": "onlyoffice", "image_url": "ghcr.io/mrmarkuz/onlyoffice:latest"}
 
 ## Configure
 
-The FQDN needs to be configured in the Web UI app settings. The FQDN is required. It should be a unique FQDN that's not already used in your NS8 else Euro Office won't be reachable.
+The FQDN needs to be configured in the Web UI app settings. The FQDN is required. It should be a unique FQDN that's not already used in your NS8 else Onlyoffice won't be reachable.
 
 ## JWT Secret
 
-To get the JWT secret that needs to be configured in client apps like Nextcloud: (in this example the instance is named euro-office1)
+To get the JWT secret that needs to be configured in client apps like Nextcloud: (in this example the instance is named onlyoffice1)
 
-    runagent -m euro-office1 grep JWT_SECRET environment
+    runagent -m onlyoffice1 grep JWT_SECRET environment
 
 ## Nextcloud
 
-- Install the Nextcloud Office 11.0.0 app 
-- Go to Nextcloud administration Nextcloud Office app settings
-- Set the "Nextcloud Office address" that is the FQDN of the Eurooffice app like `https://eurooffice.domain.tld`
-- Set the "Secret key" that you got from the previous chapter
+- Install the ONLYOFFICE app
+- Go to Nextcloud administration Onlyoffice app settings
+- Set the "Onlyoffice Docs address" that is the FQDN of the Onlyoffice app.
+- Set the "Secret key" that you got from the previous chapter.
 
-## Fetch documents from a private IP
+## Ad blockers
 
-If Nextcloud resolves to a private IP an environment variable needs to be added.
+Since Onlyoffice 9.4 (ns8-onlyoffice 1.1.7) ad blockers may block Onlyoffice so you may need to add an exception.
 
-In the following examples euro-office1 is used as app instance name, please change it to match your environment.
+## Customize configuration
 
-Edit the environment file and add "ALLOW_PRIVATE_IP_ADDRESS=true":
+Since this setup uses the official Docker image, the local.json file is regenerated each time the container starts, meaning it’s not directly mappable or persistent on the host. Any manual changes made to local.json inside the container are lost after a restart.
 
-    runagent -m euro-office1 nano environment
+The proper workaround is to create the file `/home/onlyoffice1/.local/share/containers/storage/volumes/onlyoffice-etc/_data/local-production-linux.json`. This file takes precedence over the default configuration and remains persistent across container restarts. Any changes made there are applied automatically on startup.
+
+## Use a self signed cert or how to disable the certificate check
+
+Open the Onlyoffice web app in your browser and allow the self-signed certificate to avoid an `ONLYOFFICE cannot be reached. Please contact admin` error in Nextcloud.
+
+In the following examples onlyoffice6 is used as app instance name, please change it to match your environment.
+
+Edit the environment file and add "USE_UNAUTHORIZED_STORAGE=true":
+
+    runagent -m onlyoffice1 nano environment
 
 Alternative command to add the environment variable:
 
-    runagent -m euro-office1 bash -c "grep -q ALLOW_PRIVATE_IP_ADDRESS environment || echo ALLOW_PRIVATE_IP_ADDRESS=true >> environment"
+    runagent -m onlyoffice1 bash -c "grep -q USE_UNAUTHORIZED_STORAGE environment || echo USE_UNAUTHORIZED_STORAGE=true >> environment"
 
-Restart euro-office to apply the changes:
+Restart onlyoffice to apply the changes:
 
-    runagent -m euro-office1 systemctl --user restart euro-office-app
+    runagent -m onlyoffice1 systemctl --user restart onlyoffice-app
 
 ## Uninstall
 
 To uninstall the instance:
 
-    remove-module --no-preserve euro-office1
+    remove-module --no-preserve onlyoffice1

build-images.sh

@@ -13,22 +13,22 @@ images=()
 # The image will be pushed to GitHub container registry
 repobase="${REPOBASE:-ghcr.io/mrmarkuz}"
 # Configure the image name
-reponame="euro-office"
+reponame="onlyoffice"
 
 # Create a new empty container image
 container=$(buildah from scratch)
 
-# Reuse existing nodebuilder-euro-office container, to speed up builds
-if ! buildah containers --format "{{.ContainerName}}" | grep -q nodebuilder-euro-office; then
+# Reuse existing nodebuilder-onlyoffice container, to speed up builds
+if ! buildah containers --format "{{.ContainerName}}" | grep -q nodebuilder-onlyoffice; then
     echo "Pulling NodeJS runtime..."
-    buildah from --name nodebuilder-euro-office -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
+    buildah from --name nodebuilder-onlyoffice -v "${PWD}:/usr/src:Z" docker.io/library/node:lts
 fi
 
 echo "Build static UI files with node..."
 buildah run \
     --workingdir=/usr/src/ui \
     --env="NODE_OPTIONS=--openssl-legacy-provider" \
-    nodebuilder-euro-office \
+    nodebuilder-onlyoffice \
     sh -c "yarn install && yarn build"
 
 # Add imageroot directory to the container image
@@ -46,7 +46,7 @@ buildah config --entrypoint=/ \
     --label="org.nethserver.tcp-ports-demand=1" \
     --label="org.nethserver.rootfull=0" \
 	--label="org.nethserver.min-core=3.12.4-0" \
-    --label="org.nethserver.images=ghcr.io/euro-office/documentserver:v9.3.1" \
+    --label="org.nethserver.images=docker.io/onlyoffice/documentserver:9.4.0.1" \
     "${container}"
 # Commit the image
 buildah commit "${container}" "${repobase}/${reponame}"

imageroot/actions/clone-module/50Traefik

@@ -9,6 +9,7 @@ import agent
 import os
 
 configure_retval = agent.tasks.run(agent_id=os.environ['AGENT_ID'], action='configure-module', data={
+    "lets_encrypt": os.environ["TRAEFIK_LETS_ENCRYPT"] == "True",
     "host": os.environ["TRAEFIK_HOST"],
     "http2https": os.environ["TRAEFIK_HTTP2HTTPS"] == "True",
 })

imageroot/actions/configure-module/80start_services

@@ -17,5 +17,5 @@ grep -q JWT_SECRET environment || echo "JWT_SECRET=$(head -c 1024 /dev/urandom |
 
 touch smarthost.env
 
-systemctl --user enable euro-office.service
-systemctl --user restart euro-office.service
+systemctl --user enable onlyoffice.service
+systemctl --user restart onlyoffice.service

imageroot/actions/configure-module/validate-input.json

@@ -1,11 +1,11 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Configure euro-office",
-    "$id": "http://nethserver.org/json-schema/task/input/euro-office/configure-module",
-    "description": "Configure euro-office",
+    "title": "Configure onlyoffice",
+    "$id": "http://nethserver.org/json-schema/task/input/onlyoffice/configure-module",
+    "description": "Configure onlyoffice",
     "examples": [
         {
-            "host": "euro-office.domain.org",
+            "host": "onlyoffice.domain.org",
             "http2https": true,
             "lets_encrypt": true
         }
@@ -17,7 +17,7 @@
     "properties": {
         "host": {
             "type": "string",
-            "description": "Host name for the application, like 'euro-office.domain.org'",
+            "description": "Host name for the application, like 'onlyoffice.domain.org'",
             "format": "hostname",
             "pattern": "\\."
         },

imageroot/actions/get-configuration/validate-output.json

@@ -1,11 +1,11 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Get euro-office settings",
-    "$id": "http://nethserver.org/json-schema/task/input/euro-office/get-configuration",
-    "description": "Get euro-office settings",
+    "title": "Get onlyoffice settings",
+    "$id": "http://nethserver.org/json-schema/task/input/onlyoffice/get-configuration",
+    "description": "Get onlyoffice settings",
     "examples": [
         {
-            "host": "euro-office.domain.org",
+            "host": "onlyoffice.domain.org",
             "http2https": true,
             "lets_encrypt": true
         }
@@ -19,7 +19,7 @@
     "properties": {
         "host": {
             "type": "string",
-            "description": "Host name for the application, like 'euro-office.domain.org'",
+            "description": "Host name for the application, like 'onlyoffice.domain.org'",
             "format": "idn-hostname"
         },
         "lets_encrypt": {

imageroot/actions/restore-module/06copyenv

@@ -16,7 +16,6 @@ original_environment = request['environment']
 for evar in [
         "TRAEFIK_HOST",
         "TRAEFIK_HTTP2HTTPS",
-        "JWT_SECRET",
     ]:
     agent.set_env(evar, original_environment[evar])
 

imageroot/actions/restore-module/40restore_database

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+#
+# Copyright (C) 2022 Nethesis S.r.l.
+# SPDX-License-Identifier: GPL-3.0-or-later
+#
+
+set -e -o pipefail
+exec 1>&2 # Redirect any output to the journal (stderr)
+
+# Prepare an initialization script that restores the dump file
+mkdir -vp initdb.d
+mv -v onlyoffice.sql initdb.d
+#do the bash file to restore and exit once done
+cat - >initdb.d/zz_onlyoffice_restore.sh <<'EOS'
+# Print additional information:
+mysql --version
+# The script is sourced, override entrypoint args and exit:
+set -- true
+docker_temp_server_stop
+exit 0
+EOS
+
+# once we exit we remove initdb.d
+trap 'rm -rfv initdb.d/' EXIT
+
+# we start a container to initiate a database and load the dump
+# at the end of onlyoffice_restore.sh the dump is loaded and 
+# we exit the container
+podman run \
+  --rm \
+  --interactive \
+  --network=none \
+  --volume=./initdb.d:/docker-entrypoint-initdb.d:z \
+  --volume mysql-data:/var/lib/mysql/:Z \
+  --env MARIADB_ROOT_PASSWORD=Nethesis,1234 \
+  --env MARIADB_DATABASE=onlyoffice \
+  --env MARIADB_USER=onlyoffice \
+  --env MARIADB_PASSWORD=onlyoffice \
+  --replace --name=restore_db \
+  ${MARIADB_IMAGE}

imageroot/actions/restore-module/50traefik

@@ -14,6 +14,7 @@ request = json.load(sys.stdin)
 renv = request['environment']
 
 configure_retval = agent.tasks.run(agent_id=os.environ['AGENT_ID'], action='configure-module', data={
+    "lets_encrypt": renv["TRAEFIK_LETS_ENCRYPT"] == "True",
     "host": renv["TRAEFIK_HOST"],
     "http2https": renv["TRAEFIK_HTTP2HTTPS"] == "True",
 })