Merge pull request #9131 from owncloud/backport-wopi-example

Backport wopi example
owncloud · May 10, 2024 · 1806fd4 · 1806fd4
1 parent 730936a
commit 1806fd4
Show file tree

Hide file tree

Showing 86 changed files with 143 additions and 117 deletions.
diff --git a/apis/grpc_apis/ocis/messages/eventhistory/v0/grpc.md b/apis/grpc_apis/ocis/messages/eventhistory/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.eventhistory.v0"
 url: /apis/grpc_apis/ocis_messages_eventhistory_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/messages/policies/v0/grpc.md b/apis/grpc_apis/ocis/messages/policies/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.policies.v0"
 url: /apis/grpc_apis/ocis_messages_policies_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/messages/search/v0/grpc.md b/apis/grpc_apis/ocis/messages/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.search.v0"
 url: /apis/grpc_apis/ocis_messages_search_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/messages/settings/v0/grpc.md b/apis/grpc_apis/ocis/messages/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.settings.v0"
 url: /apis/grpc_apis/ocis_messages_settings_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/messages/store/v0/grpc.md b/apis/grpc_apis/ocis/messages/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.store.v0"
 url: /apis/grpc_apis/ocis_messages_store_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/messages/thumbnails/v0/grpc.md b/apis/grpc_apis/ocis/messages/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.messages.thumbnails.v0"
 url: /apis/grpc_apis/ocis_messages_thumbnails_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/eventhistory/v0/grpc.md b/apis/grpc_apis/ocis/services/eventhistory/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.eventhistory.v0"
 url: /apis/grpc_apis/ocis_services_eventhistory_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/policies/v0/grpc.md b/apis/grpc_apis/ocis/services/policies/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.policies.v0"
 url: /apis/grpc_apis/ocis_services_policies_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/search/v0/grpc.md b/apis/grpc_apis/ocis/services/search/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.search.v0"
 url: /apis/grpc_apis/ocis_services_search_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/settings/v0/grpc.md b/apis/grpc_apis/ocis/services/settings/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.settings.v0"
 url: /apis/grpc_apis/ocis_services_settings_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/store/v0/grpc.md b/apis/grpc_apis/ocis/services/store/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.store.v0"
 url: /apis/grpc_apis/ocis_services_store_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/apis/grpc_apis/ocis/services/thumbnails/v0/grpc.md b/apis/grpc_apis/ocis/services/thumbnails/v0/grpc.md
@@ -1,7 +1,7 @@
 ---
 title: "ocis.services.thumbnails.v0"
 url: /apis/grpc_apis/ocis_services_thumbnails_v0
-date: 2024-05-10T00:41:35Z
+date: 2024-05-10T13:21:33Z
 weight: 50
 geekdocRepo: https://github.com/owncloud/ocis
 ---

diff --git a/ocis/deployment/ocis_wopi.md b/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,14 +98,35 @@ 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=
 
   ### 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:

diff --git a/services/_includes/adoc/antivirus_configvars.adoc b/services/_includes/adoc/antivirus_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the antivirus service
 [width="100%",cols="~,~,~,~",options="header"]
@@ -245,7 +245,7 @@ a| [subs=-attributes]
 The socket clamav is running on. Note the default value is an example which needs adaption according your OS.
 
 a|`ANTIVIRUS_ICAP_TIMEOUT` +
-xref:deprecation-note-2024-05-10-00-41-54[Deprecation Note]
+xref:deprecation-note-2024-05-10-13-21-59[Deprecation Note]
 a| [subs=-attributes]
 ++int64 ++
 a| [subs=-attributes]

diff --git a/services/_includes/adoc/app-provider_configvars.adoc b/services/_includes/adoc/app-provider_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the app-provider service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/app-registry_configvars.adoc b/services/_includes/adoc/app-registry_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the app-registry service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/audit_configvars.adoc b/services/_includes/adoc/audit_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the audit service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/auth-basic_configvars.adoc b/services/_includes/adoc/auth-basic_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the auth-basic service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/auth-bearer_configvars.adoc b/services/_includes/adoc/auth-bearer_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the auth-bearer service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/auth-machine_configvars.adoc b/services/_includes/adoc/auth-machine_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the auth-machine service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/auth-service_configvars.adoc b/services/_includes/adoc/auth-service_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the auth-service service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/clientlog_configvars.adoc b/services/_includes/adoc/clientlog_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the clientlog service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/eventhistory_configvars.adoc b/services/_includes/adoc/eventhistory_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the eventhistory service
 [width="100%",cols="~,~,~,~",options="header"]

diff --git a/services/_includes/adoc/frontend_configvars.adoc b/services/_includes/adoc/frontend_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the frontend service
 [width="100%",cols="~,~,~,~",options="header"]
@@ -327,7 +327,7 @@ The default upload protocol to use in clients. Currently only 'tus' is avaliable
 
 a|`OCIS_ENABLE_RESHARING` +
 `FRONTEND_ENABLE_RESHARING` +
-xref:deprecation-note-2024-05-10-00-41-54[Deprecation Note]
+xref:deprecation-note-2024-05-10-13-21-59[Deprecation Note]
 a| [subs=-attributes]
 ++bool ++
 a| [subs=-attributes]

diff --git a/services/_includes/adoc/gateway_configvars.adoc b/services/_includes/adoc/gateway_configvars.adoc
@@ -4,7 +4,7 @@
 
 ifeval::[{show-deprecation} == true]
 
-[#deprecation-note-2024-05-10-00-41-54]
+[#deprecation-note-2024-05-10-13-21-59]
 [caption=]
 .Deprecation notes for the gateway service
 [width="100%",cols="~,~,~,~",options="header"]