AppSuite:Filestorages
Common preparations
This page shows how to setup external file stores. For all of these file stores you have to install the package "open-xchange-oauth", which provides the necessary authentication mechanisms.
Moreover your setup is required to be reachable via HTTPS, since the providers expect that a call-back URL to your setup is specified. Such a call-back URL is only accepted if it contains the "https://"
scheme., e.g.:
"https://my.oxsetup.invalid/ajax/defer"
Keep HTTPS protocol
Appsuite:Grizzly#Cluster_setup shows that HTTPS communication is terminated by the Apache balancer in front of the Open-Xchange nodes. To let the Open-Xchange application know about the HTTPS protocol that is used to communicate with the Apache server:
- Either set a special header in the SSL virtual hosts configurations in Apache to forward this information. The de facto standard for this is the
"X-Forwarded-Proto"
header. See Appsuite:Grizzly#X-FORWARDED-PROTO_Header for how to setup that header. - Or force the Open-Xchange application to assume it is reached via SSL through setting property
"com.openexchange.forceHTTPS=true"
in file /opt/open-xchange/etc/server.properties.
Deferrer URL
Open-Xchange application uses the deferrer URL as call-back for some of the providers, which use OAuth v2.0 authentication (such as Google).
If your OX server is reachable only via one host name, you won't have to do anything. If it is reachable by more than one host name, create or open the file /opt/openexchange/etc/groupware/deferrer.properties and set the properties therein as such:
com.openexchange.http.deferrer.url=https://mymaindomain.invalid
Dropbox
To setup the Dropbox file store you have to install the package "open-xchange-file-storage-dropbox".
Registering your app
- Log in to your Dropbox account [[1]], and create your Dropbox App here
Configuration
In addition you have to configure the following properties in file /opt/open-xchange/etc/dropboxoauth.properties:
- Enable the OAuth connector to Dropbox OAuth
com.openexchange.oauth.dropbox=true
- Set the API key and secret
com.openexchange.oauth.dropbox.apiKey=REPLACE_THIS_WITH_DROPBOX_APP_KEY
com.openexchange.oauth.dropbox.apiSecret=REPLACE_THIS_WITH_DROPBOX_APP_SECRET
You can define them system-wide or via the config cascade mechanism.
Install on OX App Suite
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-dropbox
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-dropbox
Google Drive
To setup the Google Drive file store you have to install the package "open-xchange-file-storage-googledrive". In addition you have to configure the following properties:
# Enable/disable com.openexchange.oauth.google=true # The API key com.openexchange.oauth.google.apiKey=REPLACE_THIS_WITH_YOUR_CLIENT_ID # The API secret com.openexchange.oauth.google.apiSecret=REPLACE_THIS_WITH_YOUR_CLIENT_SECRET # The redirect URL # # Please ensure the following conditions are met: # * The redirect URL specified in the Google App needs to be the same as the one specified by this property. # * The redirect URI uses "https://" as protocol # * The redirect URI follows the pattern: "https://" + <host-name> + "/ajax/defer" # # E.g. "https://myappsuite.mydomain.invalid/ajax/defer" com.openexchange.oauth.google.redirectUrl=REPLACE_THIS_WITH_YOUR_GOOGLE_REDIRECT_URI # The product name of the registered Google App com.openexchange.oauth.google.productName=REPLACE_THIS_WITH_YOUR_PRODUCT_NAME
You can define them system wide within googleoauth.properties or via the config cascade mechanism.
Install on OX App Suite
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-googledrive
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-googledrive
Microsoft Onedrive
To setup the Microsoft OneDrive file store you have to install the package "open-xchange-file-storage-onedrive". In addition you have to configure the following properties:
# Enable/disable com.openexchange.oauth.msliveconnect=true # The API key com.openexchange.oauth.msliveconnect.apiKey=REPLACE_THIS_WITH_YOUR_MS_LIVE_CONNECT_KEY # The API secret com.openexchange.oauth.msliveconnect.apiSecret=REPLACE_THIS_WITH_YOUR_MS_LIVE_CONNECT_SECRET # The redirect URL # e.g. "https://myappsuite.mydomain.invalid/ajax/defer" com.openexchange.oauth.msliveconnect.redirectUrl=REPLACE_THIS_WITH_YOUR_MS_LIVE_CONNECT_REDIRECT_URL
You can define them system wide within msliveconntectoauth.properties or via the config cascade mechanism.
Install on OX App Suite
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-onedrive
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-onedrive
Boxcom
To setup the Boxcom file store you have to install the package "open-xchange-file-storage-boxcom". In addition you have to configure the following properties:
# Enable/disable com.openexchange.oauth.boxcom=true # The API key com.openexchange.oauth.boxcom.apiKey=REPLACE_THIS_WITH_YOUR_BOX_COM_KEY # The API secret com.openexchange.oauth.boxcom.apiSecret=REPLACE_THIS_WITH_YOUR_BOX_COM_SECRET # The redirect URL # e.g. "https://myappsuite.mydomain.invalid/ajax/defer" com.openexchange.oauth.boxcom.redirectUrl=REPLACE_THIS_WITH_YOUR_BOX_COM_REDIRECT_URL
You can define them system wide within boxcomoauth.properties or via the config cascade mechanism.
Install on OX App Suite
Debian GNU/Linux 11.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBullseye/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBullseye/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-boxcom
Debian GNU/Linux 12.0
Add the following entry to /etc/apt/sources.list.d/open-xchange.list if not already present:
deb https://software.open-xchange.com/products/appsuite/stable/backend/DebianBookworm/ /
# if you have a valid maintenance subscription, please uncomment the
# following and add the ldb account data to the url so that the most recent
# packages get installed
# deb https://[CUSTOMERID:PASSWORD]@software.open-xchange.com/products/appsuite/stable/backend/updates/DebianBookworm/ /
and run
$ apt-get update $ apt-get install open-xchange-file-storage-boxcom