README update for imaginary

Reviewed-on: coop-cloud/nextcloud#49

.env.sample

@@ -55,6 +55,12 @@ DEFAULT_QUOTA="10 GB"
 # APPS="calendar"
 
 # COLLABORA_URL=https://collabora.example.com
+## IMPORTANT FOR SECURITY REASONS WHEN RUNNING COLLABORA
+## list of IP addresses that are allowed to make WOPI requests. Use the default
+## when running the collabora server on the same machine as nextcloud.
+## Otherwise set this to the IP address range of your collabora server(s) i.e. 1.2.3.4/32
+## https://docs.nextcloud.com/server/latest/admin_manual/office/configuration.html#wopi-settings
+# COLLABORA_ALLOWLIST="172.16.0.0/12"
 
 # COMPOSE_FILE="$COMPOSE_FILE:compose.onlyoffice.yml"
 # ONLYOFFICE_URL=https://onlyoffice.example.com
@@ -82,8 +88,11 @@ DEFAULT_QUOTA="10 GB"
 #COMPOSE_FILE="$COMPOSE_FILE:compose.fulltextsearch.yml"
 #SECRET_ELASTICSEARCH_PASSWORD_VERSION=v1
 
+# Image / PDF previews with Imaginary (see README)
+#COMPOSE_FILE="$COMPOSE_FILE:compose.imaginary-preview.yml"
+
 # HSTS Options
 # Uncomment this line to enable HSTS: https://docs.nextcloud.com/server/30/admin_manual/installation/harden_server.html
 #HSTS_ENABLED=1
 # Uncomment this line to add the `preload` part
-#HSTS_PRELOAD=1
+#HSTS_PRELOAD=1

README.md

@@ -249,6 +249,20 @@ docker exec -u www-data $(docker ps -f name=foo_com_app -q) ./occ preview:pre-ge
 
 This app will improve performance of image browsing at the cost of storage space.
 
+## Better image previews with `imaginary`
+
+1. Run `abra app config <domain>` and uncomment the line `#COMPOSE_FILE="$COMPOSE_FILE:compose.imaginary-preview.yml"`.
+2. Re-deploy the app (`abra app deploy <domain> --force`)
+3. Edit `/var/www/config/config.php` and add:
+
+  ```
+  'enabledPreviewProviders' => 
+  array (
+    0 => 'OC\\Preview\\Imaginary',
+  ),
+  'preview_imaginary_url' => 'http://imaginary:9000',
+  ```
+
 ## Fulltextsearch using elasticsearch
 
 1. Uncomment the following lines in your env file:

abra.sh

@@ -92,6 +92,9 @@ install_onlyoffice() {
 install_collabora() {
     install_apps richdocuments
     set_app_config richdocuments wopi_url "$COLLABORA_URL"
+    # important for security reaosns
+    # https://docs.nextcloud.com/server/latest/admin_manual/office/configuration.html#wopi-settings
+    set_app_config richdocuments wopi_allowlist "$COLLABORA_ALLOWLIST"
 }
 
 install_whiteboard() {
@@ -169,4 +172,4 @@ set_windowsfriendly_filenames() {
 
 upgrade_mariadb() {
     mariadb-upgrade -p`cat /run/secrets/db_root_password`
-}
+}

compose.imaginary-preview.yml

@@ -0,0 +1,10 @@
+---
+version: '3.8'
+services:
+  imaginary:
+    image: nextcloud/aio-imaginary:20250822_112758
+    environment:
+      - PORT=9000
+    command: -concurrency 50 -enable-url-source -log-level debug
+    networks:
+      - internal

compose.yml

@@ -74,6 +74,7 @@ services:
       - TRUSTED_PROXIES=10.0.0.0/8
       - REDIS_HOST=cache
       - OVERWRITEPROTOCOL=https
+      - OVERWRITECLIURL=https://${DOMAIN}
       - PHP_MEMORY_LIMIT=${PHP_MEMORY_LIMIT:-1G}
       - FPM_MAX_CHILDREN=${FPM_MAX_CHILDREN:-131}
       - FPM_START_SERVERS=${FPM_START_SERVERS:-32}
@@ -93,7 +94,7 @@ services:
         failure_action: rollback
         order: start-first
       labels:
-        - "coop-cloud.${STACK_NAME}.version=12.0.0+31.0.6-fpm"
+        - "coop-cloud.${STACK_NAME}.version=12.0.1+31.0.6-fpm"
         - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
         - "backupbot.backup=${ENABLE_BACKUPS:-true}"
         - "backupbot.backup.volumes.redis=false"