Install on Nubus for UCS

3.1. Install on Nubus for UCS#

As an administrator, you can install the OX Connector app with Univention App Center.

Before you start, make sure that your environment meets the OX Connector app in Univention App Center. Identify the required app settings.

You can install the app in Nubus for UCS in the following ways:

See also

Univention App Center

in Nubus for UCS 5.2 - Operation Manual [1] to learn how to install apps with Univention App Center.

3.1.1. Install with a web browser#

To install the OX Connector with the Management UI in Nubus, use the following steps.

Before you start, make sure that you have a user account with access to administrative management modules.

For more information, see Choose the right user account in Nubus Manual 1.x [6].

  1. In a web browser, sign in to the Management UI.

  2. Open the App Center management module.

  3. Select OX Connector or search for it, and then open the app.

  4. Click Install.

  5. Configure the App settings for your environment. For a reference, see App settings.

  6. Click Start Installation.

  7. Verify that App Center shows the OX Connector app as installed.

See also

How to install applications

in Nubus for UCS 5.2 - Operation Manual [1] for information about app installations.

3.1.2. Install from the command line#

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

  1. Open a terminal or connect to a remote shell. Use a user account that has administrative rights, for example root.

  2. Determine the app settings for your environment. To pass custom settings to the app during installation, use the command template in Listing 3.1.

    Replace the following placeholders:

    • SETTING_KEY with the app setting name.

    • SETTING_VALUE with the value.

    For an example, see Listing 3.2.

    For a reference, see App settings.

  3. Prepare credentials for the installation command. Before you run the installation command, make sure that you can provide the password for the domain administrator account, such as Administrator.

    Tip

    To use a different account, pass the account name with --username and the password file with --pwdfile. For more information, see univention-app install -h.

  4. Install the OX Connector app with the univention-app install command.

    The following command shows the syntax for passing app settings during installation.

    Listing 3.1 Install OX Connector from the command line#
    $ univention-app install ox-connector --set SETTING_KEY=SETTING_VALUE

    The following example shows multiple app settings in one installation command.

    Listing 3.2 Example: Set app settings for OX Connector during installation#
    $ univention-app install ox-connector --set \
  OX_MASTER_ADMIN="oxadminmaster" \
  OX_MASTER_PASSWORD="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"

    Caution

    Command-line passwords can appear in the shell history or process list. Use this method only on a trusted system.

  5. Verify that App Center shows the OX Connector app as installed. You must check the installed state in App Center.

On this page