Merge pull request #6702 from owncloud/uppy-companion

Add Uppy Companion to wopi example
owncloud · Feb 6, 2024 · d3d4d59 · d3d4d59
2 parents 1a52b04 + 3860ed4
commit d3d4d59
Show file tree

Hide file tree

Showing 8 changed files with 102 additions and 1 deletion.
diff --git a/deployments/continuous-deployment-config/ocis_wopi/daily.yml b/deployments/continuous-deployment-config/ocis_wopi/daily.yml
@@ -34,6 +34,9 @@
           TRAEFIK_ACME_MAIL: [email protected]
           OCIS_DOCKER_TAG: latest
           OCIS_DOMAIN: ocis.ocis-wopi.daily.owncloud.works
+          COMPANION_DOMAIN: companion.ocis-wopi.daily.owncloud.works
+          COMPANION_WEB_CONFIG_FILE_NAME: web-daily.yaml
+          COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud
           WOPISERVER_DOMAIN: wopiserver.ocis-wopi.daily.owncloud.works
           COLLABORA_DOMAIN: collabora.ocis-wopi.daily.owncloud.works
           ONLYOFFICE_DOMAIN: onlyoffice.ocis-wopi.daily.owncloud.works

diff --git a/deployments/continuous-deployment-config/ocis_wopi/latest.yml b/deployments/continuous-deployment-config/ocis_wopi/latest.yml
@@ -34,6 +34,9 @@
           TRAEFIK_ACME_MAIL: [email protected]
           OCIS_DOCKER_TAG: latest
           OCIS_DOMAIN: ocis.ocis-wopi.latest.owncloud.works
+          COMPANION_DOMAIN: companion.ocis-wopi.latest.owncloud.works
+          COMPANION_WEB_CONFIG_FILE_NAME: web-latest.yaml
+          COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud
           WOPISERVER_DOMAIN: wopiserver.ocis-wopi.latest.owncloud.works
           COLLABORA_DOMAIN: collabora.ocis-wopi.latest.owncloud.works
           ONLYOFFICE_DOMAIN: onlyoffice.ocis-wopi.latest.owncloud.works

diff --git a/deployments/continuous-deployment-config/ocis_wopi/released.yml b/deployments/continuous-deployment-config/ocis_wopi/released.yml
@@ -34,6 +34,9 @@
           TRAEFIK_ACME_MAIL: [email protected]
           OCIS_DOCKER_TAG: 4.0.0
           OCIS_DOMAIN: ocis.ocis-wopi.released.owncloud.works
+          COMPANION_DOMAIN: companion.ocis-wopi.released.owncloud.works
+          COMPANION_IMAGE: owncloud/uppy-companion:3.12.13-owncloud
+          COMPANION_WEB_CONFIG_FILE_NAME: web-released.yaml
           WOPISERVER_DOMAIN: wopiserver.ocis-wopi.released.owncloud.works
           COLLABORA_DOMAIN: collabora.ocis-wopi.released.owncloud.works
           ONLYOFFICE_DOMAIN: onlyoffice.ocis-wopi.released.owncloud.works

diff --git a/deployments/examples/ocis_wopi/.env b/deployments/examples/ocis_wopi/.env
@@ -47,11 +47,20 @@ ONLYOFFICE_DOMAIN=
 # Inbucket / Mail domain. Defaults to "mail.owncloud.test"
 INBUCKET_DOMAIN=
 
-### Apache Tika Content analysis toolkit
+### Apache Tika Content analysis toolkit ###
 # Set the desired docker image tag or digest, defaults to "latest"
 TIKA_IMAGE=
 
 # If you want to use debugging and tracing with this stack,
 # you need uncomment following line. Please see documentation at
 # https://owncloud.dev/ocis/deployment/monitoring-tracing/
 #COMPOSE_FILE=docker-compose.yml:monitoring_tracing/docker-compose-additions.yml
+
+### Uppy Companion settings ###
+# Domain of Uppy Companion. Defaults to "companion.owncloud.test"
+COMPANION_IMAGE=
+COMPANION_DOMAIN=
+COMPANION_WEB_CONFIG_FILE_NAME=
+# Provider settings, see https://uppy.io/docs/companion/#provideroptions for reference. Empty by default, which disables providers.
+COMPANION_ONEDRIVE_KEY=
+COMPANION_ONEDRIVE_SECRET=
diff --git a/deployments/examples/ocis_wopi/config/ocis/web-daily.yaml b/deployments/examples/ocis_wopi/config/ocis/web-daily.yaml
@@ -0,0 +1,18 @@
+web:
+  config:
+    external_apps:
+      - id: preview
+        path: web-app-preview
+        config:
+          mimeTypes:
+            - image/tiff
+            - image/bmp
+            - image/x-ms-bmp
+      - id: importer
+        path: web-app-importer
+        config:
+          companionUrl: https://companion.ocis-wopi.daily.owncloud.works
+          supportedClouds:
+            - WebdavPublicLink
+            #- OneDrive # needs a client id and secret
+            #- GoogleDrive # needs a client id and secret and an addition to the DNS zone
diff --git a/deployments/examples/ocis_wopi/config/ocis/web-latest.yaml b/deployments/examples/ocis_wopi/config/ocis/web-latest.yaml
@@ -0,0 +1,18 @@
+web:
+  config:
+    external_apps:
+      - id: preview
+        path: web-app-preview
+        config:
+          mimeTypes:
+            - image/tiff
+            - image/bmp
+            - image/x-ms-bmp
+      - id: importer
+        path: web-app-importer
+        config:
+          companionUrl: https://companion.ocis-wopi.latest.owncloud.works
+          supportedClouds:
+            - WebdavPublicLink
+            #- OneDrive # needs a client id and secret
+            #- GoogleDrive # needs a client id and secret and an addition to the DNS zone
diff --git a/deployments/examples/ocis_wopi/config/ocis/web-released.yaml b/deployments/examples/ocis_wopi/config/ocis/web-released.yaml
@@ -0,0 +1,18 @@
+web:
+  config:
+    external_apps:
+      - id: preview
+        path: web-app-preview
+        config:
+          mimeTypes:
+            - image/tiff
+            - image/bmp
+            - image/x-ms-bmp
+      - id: importer
+        path: web-app-importer
+        config:
+          companionUrl: https://companion.ocis-wopi.released.owncloud.works
+          supportedClouds:
+            - WebdavPublicLink
+            #- OneDrive # needs a client id and secret
+            #- GoogleDrive # needs a client id and secret and an addition to the DNS zone
diff --git a/deployments/examples/ocis_wopi/docker-compose.yml b/deployments/examples/ocis_wopi/docker-compose.yml
@@ -11,6 +11,7 @@ services:
           - ${WOPISERVER_DOMAIN:-wopiserver.owncloud.test}
           - ${COLLABORA_DOMAIN:-collabora.owncloud.test}
           - ${ONLYOFFICE_DOMAIN:-onlyoffice.owncloud.test}
+          - ${COMPANION_DOMAIN:-companion.owncloud.test}
     command:
       - "--log.level=${TRAEFIK_LOG_LEVEL:-ERROR}"
       # letsencrypt configuration
@@ -89,6 +90,7 @@ services:
       NATS_NATS_PORT: 9233
     volumes:
       - ./config/ocis/app-registry.yaml:/etc/ocis/app-registry.yaml
+      - ./config/ocis/${COMPANION_WEB_CONFIG_FILE_NAME:-web.yaml}:/etc/ocis/web.yaml
       - ocis-config:/etc/ocis
       - ocis-data:/var/lib/ocis
     labels:
@@ -245,6 +247,32 @@ services:
       ocis-net:
     restart: always
 
+  companion:
+    image: ${COMPANION_IMAGE:-transloadit/companion:4.5.1}
+    networks:
+      ocis-net:
+    environment:
+      NODE_ENV: production
+      NODE_TLS_REJECT_UNAUTHORIZED: 0
+      COMPANION_DATADIR: /tmp/companion/
+      COMPANION_DOMAIN: ${COMPANION_DOMAIN:-companion.owncloud.test}
+      COMPANION_PROTOCOL: https
+      COMPANION_UPLOAD_URLS: "^https://${OCIS_DOMAIN:-ocis.owncloud.test}/"
+      COMPANION_ONEDRIVE_KEY: "${COMPANION_ONEDRIVE_KEY}"
+      COMPANION_ONEDRIVE_SECRET: "${COMPANION_ONEDRIVE_SECRET}"
+    volumes:
+      - companion-data:/tmp/companion/
+    labels:
+      - "traefik.enable=true"
+      - "traefik.http.routers.companion.entrypoints=https"
+      - "traefik.http.routers.companion.rule=Host(`${COMPANION_DOMAIN:-companion.owncloud.test}`)"
+      - "traefik.http.routers.companion.tls.certresolver=http"
+      - "traefik.http.routers.companion.service=companion"
+      - "traefik.http.services.companion.loadbalancer.server.port=3020"
+    logging:
+      driver: "local"
+    restart: always
+
   inbucket:
     image: inbucket/inbucket
     networks:
@@ -273,6 +301,7 @@ volumes:
   ocis-config:
   ocis-data:
   wopi-recovery:
+  companion-data:
 
 networks:
   ocis-net: