From e1cf1d684507456a5ed91f961a5d15039e4074df Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Fri, 10 May 2024 11:55:42 +0200 Subject: [PATCH] fix: companion config --- .../ocis_wopi/config/ocis/web-latest.yaml | 18 ----------- .../ocis_wopi/config/ocis/web-released.yaml | 18 ----------- .../config/ocis/{web-daily.yaml => web.yaml} | 2 +- .../examples/ocis_wopi/docker-compose.yml | 2 +- docs/ocis/deployment/ocis_wopi.md | 30 +++++++++++++++++-- 5 files changed, 30 insertions(+), 40 deletions(-) delete mode 100644 deployments/examples/ocis_wopi/config/ocis/web-latest.yaml delete mode 100644 deployments/examples/ocis_wopi/config/ocis/web-released.yaml rename deployments/examples/ocis_wopi/config/ocis/{web-daily.yaml => web.yaml} (86%) diff --git a/deployments/examples/ocis_wopi/config/ocis/web-latest.yaml b/deployments/examples/ocis_wopi/config/ocis/web-latest.yaml deleted file mode 100644 index 54c7b1b13..000000000 --- a/deployments/examples/ocis_wopi/config/ocis/web-latest.yaml +++ /dev/null @@ -1,18 +0,0 @@ -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 deleted file mode 100644 index 1a208841f..000000000 --- a/deployments/examples/ocis_wopi/config/ocis/web-released.yaml +++ /dev/null @@ -1,18 +0,0 @@ -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/config/ocis/web-daily.yaml b/deployments/examples/ocis_wopi/config/ocis/web.yaml similarity index 86% rename from deployments/examples/ocis_wopi/config/ocis/web-daily.yaml rename to deployments/examples/ocis_wopi/config/ocis/web.yaml index b8890ac32..9ffff9481 100644 --- a/deployments/examples/ocis_wopi/config/ocis/web-daily.yaml +++ b/deployments/examples/ocis_wopi/config/ocis/web.yaml @@ -11,7 +11,7 @@ web: - id: importer path: web-app-importer config: - companionUrl: https://companion.ocis-wopi.daily.owncloud.works + companionUrl: https://${COMPANION_DOMAIN|companion.owncloud.test} supportedClouds: - WebdavPublicLink #- OneDrive # needs a client id and secret diff --git a/deployments/examples/ocis_wopi/docker-compose.yml b/deployments/examples/ocis_wopi/docker-compose.yml index 7fd7c4ebc..5f26e615c 100644 --- a/deployments/examples/ocis_wopi/docker-compose.yml +++ b/deployments/examples/ocis_wopi/docker-compose.yml @@ -94,7 +94,7 @@ services: volumes: - ./config/ocis/app-registry.yaml:/etc/ocis/app-registry.yaml - ./config/ocis/csp.yaml:/etc/ocis/csp.yaml - - ./config/ocis/${COMPANION_WEB_CONFIG_FILE_NAME:-web.yaml}:/etc/ocis/web.yaml + - ./config/ocis/web.yaml:/etc/ocis/web.yaml - ocis-config:/etc/ocis - ocis-data:/var/lib/ocis labels: diff --git a/docs/ocis/deployment/ocis_wopi.md b/docs/ocis/deployment/ocis_wopi.md index deac95a99..c70b2ad67 100644 --- a/docs/ocis/deployment/ocis_wopi.md +++ b/docs/ocis/deployment/ocis_wopi.md @@ -41,6 +41,7 @@ The last four containers are the WOPI server, Collabora and OnlyOffice. * onlyoffice.* for serving OnlyOffice * wopiserver.* for serving the WOPI server * traefik.* for serving the Traefik dashboard + * companion.* for serving the uppy companion app See also [example server setup]({{< ref "preparing_server" >}}) @@ -68,7 +69,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) TRAEFIK_DASHBOARD= # Domain of Traefik, where you can find the dashboard. Defaults to "traefik.owncloud.test" TRAEFIK_DOMAIN= - # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" + # Basic authentication for the dashboard. Defaults to user "admin" and password "admin" (written as: "admin:admin"). TRAEFIK_BASIC_AUTH_USERS= # Email address for obtaining LetsEncrypt certificates, needs only be changed if this is a public facing server TRAEFIK_ACME_MAIL= @@ -83,6 +84,8 @@ See also [example server setup]({{< ref "preparing_server" >}}) # The demo users should not be created on a production instance # because their passwords are public. Defaults to "false". DEMO_USERS= + # Log level for oCIS. Defaults to "info". + OCIS_LOG_LEVEL= ### Wopi server settings ### # cs3org wopi server version. Defaults to "v8.3.3" @@ -95,7 +98,7 @@ See also [example server setup]({{< ref "preparing_server" >}}) ### Collabora settings ### # Domain of Collabora, where you can find the frontend. Defaults to "collabora.owncloud.test" COLLABORA_DOMAIN= - # Admin user for Collabora. Defaults to blank, provide one to enable access + # Admin user for Collabora. Defaults to blank, provide one to enable access. Collabora Admin Panel URL: https://{COLLABORA_DOMAIN}/browser/dist/admin/admin.html COLLABORA_ADMIN_USER= # Admin password for Collabora. Defaults to blank, provide one to enable access COLLABORA_ADMIN_PASSWORD= @@ -103,6 +106,27 @@ See also [example server setup]({{< ref "preparing_server" >}}) ### OnlyOffice settings ### # Domain of OnlyOffice, where you can find the frontend. Defaults to "onlyoffice.owncloud.test" ONLYOFFICE_DOMAIN= + + ### Email / Inbucket settings ### + # Inbucket / Mail domain. Defaults to "mail.owncloud.test" + INBUCKET_DOMAIN= + + ### 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= + # Provider settings, see https://uppy.io/docs/companion/#provideroptions for reference. Empty by default, which disables providers. + COMPANION_ONEDRIVE_KEY= + COMPANION_ONEDRIVE_SECRET= ``` You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`. @@ -152,6 +176,8 @@ On Linux and macOS you can add them to your `/etc/hosts` file and on Windows to 127.0.0.1 collabora.owncloud.test 127.0.0.1 onlyoffice.owncloud.test 127.0.0.1 wopiserver.owncloud.test +127.0.0.1 mail.owncloud.test +127.0.0.1 companion.owncloud.test ``` After that you're ready to start the application stack: