OX Connector app

Download PDF

Installation

1. Installation#

The OX Connector app connects the UCS identity management with the OX App Suite database. For more information about how it works, see How the connector works.

1.1. Prerequisites#

Before you as administrator can install the OX Connector app, you need to make sure that your environment fulfills the prerequisites.

1.1.1. OX App Suite server#

For the OX App Suite server, you must ensure the following prerequisites:

  1. The environment requires an installed OX App Suite instance. This documentation assumes that an OX App Suite installation already exists.

    For limitations about the OX App Suite app from Univention App Center and the connector, see Integration of OX Connector and OX App Suite app.

    For installation of OX App Suite, see App Suite Admin Guide 7.10.5 [1].

  2. The OX App Suite instance must allow SOAP requests, so that the UCS system, where the administrator installs the OX Connector app, can connect to /webservices.

  3. You have to set up an administrator user in OX App Suite that can create OX contexts.

    The OX Connector can manage OX contexts. The installation of the OX Connector app needs username and password for that user and references them in the setting OX_MASTER_ADMIN and OX_MASTER_PASSWORD.

    For manually managing OX contexts without the OX Connector, see Contexts.

  4. Since version 2.2.0, OX must allow the use of duplicated displaynames. To enable it, add the following lines to the user.properties file.

    com.openexchange.user.enforceUniqueDisplayName=false
com.openexchange.folderstorage.database.preferDisplayName=false

    Note

    This is configured by default in version 7.10.6-ucs7 of OX App Suite from the App Center.

1.1.2. UCS domain#

Another prerequisite needs some steps in the UCS domain. To use the OX Connector app, the central LDAP directory needs the referential integrity overlay enabled. The overlay ensures that UDM objects provided by the OX Connector keep their integrity and always reference user objects correctly in the LDAP directory.

If you install OX Connector on Primary Directory Node, the app already takes care of the necessary step. No further action required.

If you install OX Connector on other UCS system roles than the Primary Directory Node, you need to run the following commands:

Listing 1.1 Activate OpenLDAP referential integrity overlay on Primary Directory Node.#
$ ucr set ldap/refint=true
$ service slapd restart

For more information about the referential integrity overlay, see Referential Integrity in OpenLDAP Software 2.4 Administrator's Guide [4].

1.2. Installation on UCS system#

As administrator, you can install the OX Connector app like any other app with Univention App Center. Make sure to fulfill the Prerequisites.

UCS offers two different ways for app installation:

  • With the web browser in the UCS management system

  • With the command-line

For general information about Univention App Center and how to use it for software installation, see Univention App Center in UCS 5.0 Manual [2].

1.2.1. With the web browser#

To install OX Connector from the UCS management system, use the following steps:

  1. Use a web browser and sign in to the UCS management system.

  2. Open the App Center.

  3. Select or search for OX Connector and open the app with a click.

  4. To install the OX Connector, click Install.

  5. Adjust the App settings to your preferences. For a reference, see Configuration.

  6. To start the installation, click Start Installation.

Note

To install apps, the user account you choose for login to the UCS management system must have domain administration rights, for example the username Administrator. User accounts with domain administration rights belong to the user group Domain Admins.

For more information, see Delegated administration for UMC modules in UCS 5.0 Manual [2].

1.2.2. With the command-line#

To install the OX Connector app from the command-line, use the following steps:

  1. Sign in to a terminal or remote shell with a username with administration rights, for example root.

  2. Adjust the settings to your preferences with the appropriate installation command. For a reference, see Configuration. To pass customized settings to the app during installation, see the following command template:

    $ univention-app install ox-connector --set $SETTING_KEY=$SETTING_VALUE

    Example:

    $ univention-app install ox-connector --set \
  OX_MASTER_ADMIN="oxadminmaster" \
  OX_MASTER_PASSWORD="some secure password" \
  LOCAL_TIMEZONE="Europe/Berlin"` \
  OX_LANGUAGE="de_DE" \
  DEFAULT_CONTEXT="10" \
  OX_SMTP_SERVER="smtp://my-smtp.example.com:587" \
  OX_IMAP_SERVER="imap://my-imap.example.com:143" \
  OX_SOAP_SERVER="https://my-ox.example.com"

    Note

    The installation process asks for the password of the domain administrator Administrator. To use another username and password for installation, pass different values with the options --username and --pwdfile. For more information, see univention-app install -h.

On this page