### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.3.1/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.3.2/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.3.3/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.3.4/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.3.0/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/latest/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.3/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.7/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.5/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.9/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.1/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.2/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.8/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.15/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.6/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.14/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.0/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.11/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.12/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.13/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### OX Connector Installation Example

Source: https://docs.software-univention.de/ox-connector-app/2.2.10/_sources/installation

An example demonstrating the installation of the OX Connector app with several common configuration parameters set.

```console
$ 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"
```

--------------------------------

### Example Installation Profile

Source: https://docs.software-univention.de/installation-4.0

Provides an example of a Univention Corporate Server installation profile file. This file can be used to automate the configuration of a UCS appliance during installation.

```APIDOC
Example Installation Profile:
  # System Properties
  SYSTEM_HOSTNAME=ucs-server.example.com
  SYSTEM_TIMEZONE=Europe/Berlin
  SYSTEM_KEYBOARD_LAYOUT=de

  # Domain Join
  JOIN_DOMAIN=example.com
  JOIN_DOMAIN_TYPE=AD
  JOIN_USERNAME=Administrator
  JOIN_PASSWORD=your_password

  # Network Configuration
  NETWORK_INTERFACE_0_IP=192.168.1.100
  NETWORK_INTERFACE_0_NETMASK=255.255.255.0
  NETWORK_INTERFACE_0_GATEWAY=192.168.1.1
  NETWORK_INTERFACE_0_DNS_1=192.168.1.1

  # Software Selection
  SOFTWARE_SELECTION=ucs-server,univention-directory-manager
```

--------------------------------

### Debian Post-Installation Script for UCR Setup

Source: https://docs.software-univention.de/developer-reference/latest/en/ucr/examples

Shell script executed after a Debian package is configured. This example sets the 'atd/autostart' UCR variable to 'yes' upon new installations to ensure the AT daemon starts automatically.

```shell
#!/bin/sh

case "$1" in
configure)
  ucr set atd/autostart?yes
  ;;
esac

#DEBHELPER#

exit 0

```

--------------------------------

### Debian Post-Installation Script for UCR Setup

Source: https://docs.software-univention.de/developer-reference/5.2/en/ucr/examples

Shell script executed after a Debian package is configured. This example sets the 'atd/autostart' UCR variable to 'yes' upon new installations to ensure the AT daemon starts automatically.

```shell
#!/bin/sh

case "$1" in
configure)
  ucr set atd/autostart?yes
  ;;
esac

#DEBHELPER#

exit 0

```

--------------------------------

### Supported UCS Versions Example

Source: https://docs.software-univention.de/app-center/5.0/en/_sources/get_started

Defines the specific UCS versions for which the application is compatible. This ensures correct installation and compatibility checks within the UCS App Center.

```text
4.4-8
5.0-0
```

--------------------------------

### Install UCS Intercom Service (Custom Realm Example)

Source: https://docs.software-univention.de/intercom-service/1.4/installation

An example demonstrating how to install the UCS Intercom Service app with a specific custom setting, such as defining a different Keycloak realm name. Some settings cannot be changed after installation.

```shell
$
univention-app install intercom-service \
  --set intercom-service/keycloak/realm-name=master
```

--------------------------------

### Univention System Setup Boot Configuration

Source: https://docs.software-univention.de/installation-4.1

Controls the behavior of the Univention System Setup boot process. This snippet disables the automatic starting of the setup and specifies the server role and components to be installed.

```debian-preseed
d-i ucr/system/setup/boot/start string false
univention-system-setup-boot uss/components string
univention-system-setup-boot uss/packages_install string
univention-system-setup-boot uss/packages_remove string
univention-system-setup-boot uss/server/role string memberserver
```

--------------------------------

### Install Keycloak App (Custom Admin User CLI)

Source: https://docs.software-univention.de/keycloak-app/18.0.0/installation

Example of installing the Keycloak app with a custom administration user specified via the --set flag. This demonstrates how to pass specific configuration parameters during installation.

```bash
$ univention-app install --set keycloak/admin/user="Administrator" keycloak

```

--------------------------------

### Univention System Setup Boot Preseed Configuration

Source: https://docs.software-univention.de/installation-4.4

Configuration to disable the automatic start of the Univention System Setup Boot process.

```preseed
# Disable starting "Univention System Setup Boot" ❼
d-i ucr/system/setup/boot/start string false
```

--------------------------------

### UCS Domain Setup Roles

Source: https://docs.software-univention.de/quickstart/latest/en/_sources/index

During UCS installation, the system can be configured for different roles within a domain. These roles determine the system's function, such as being the primary domain controller, joining an existing Active Directory domain, or acting as a member server in a UCS domain.

```APIDOC
UCS System Roles:

1. Primary Domain Controller (PDC):
   - Configures the system as the first server in a new UCS domain.
   - Implicitly assigned the system role |UCSPRIMARYDN|.

2. Active Directory Member Server:
   - Joins an existing Active Directory domain.
   - UCS takes on the role of an Active Directory member server.

3. UCS Domain Member:
   - Joins an existing UCS domain.
   - All other systems join the UCS domain when installed.
```

--------------------------------

### UCS Domain Setup Roles

Source: https://docs.software-univention.de/quickstart/latest/de/_sources/index

During UCS installation, the system can be configured for different roles within a domain. These roles determine the system's function, such as being the primary domain controller, joining an existing Active Directory domain, or acting as a member server in a UCS domain.

```APIDOC
UCS System Roles:

1. Primary Domain Controller (PDC):
   - Configures the system as the first server in a new UCS domain.
   - Implicitly assigned the system role |UCSPRIMARYDN|.

2. Active Directory Member Server:
   - Joins an existing Active Directory domain.
   - UCS takes on the role of an Active Directory member server.

3. UCS Domain Member:
   - Joins an existing UCS domain.
   - All other systems join the UCS domain when installed.
```

--------------------------------

### UCS Domain Setup Roles

Source: https://docs.software-univention.de/quickstart/5.2/en/_sources/index

During UCS installation, the system can be configured for different roles within a domain. These roles determine the system's function, such as being the primary domain controller, joining an existing Active Directory domain, or acting as a member server in a UCS domain.

```APIDOC
UCS System Roles:

1. Primary Domain Controller (PDC):
   - Configures the system as the first server in a new UCS domain.
   - Implicitly assigned the system role |UCSPRIMARYDN|.

2. Active Directory Member Server:
   - Joins an existing Active Directory domain.
   - UCS takes on the role of an Active Directory member server.

3. UCS Domain Member:
   - Joins an existing UCS domain.
   - All other systems join the UCS domain when installed.
```

--------------------------------

### UCS Domain Setup Roles

Source: https://docs.software-univention.de/quickstart/5.2/de/_sources/index

During UCS installation, the system can be configured for different roles within a domain. These roles determine the system's function, such as being the primary domain controller, joining an existing Active Directory domain, or acting as a member server in a UCS domain.

```APIDOC
UCS System Roles:

1. Primary Domain Controller (PDC):
   - Configures the system as the first server in a new UCS domain.
   - Implicitly assigned the system role |UCSPRIMARYDN|.

2. Active Directory Member Server:
   - Joins an existing Active Directory domain.
   - UCS takes on the role of an Active Directory member server.

3. UCS Domain Member:
   - Joins an existing UCS domain.
   - All other systems join the UCS domain when installed.
```

--------------------------------

### Get Administrator Password using kubectl

Source: https://docs.software-univention.de/nubus-kubernetes-operation/latest/en/_sources/getting-started

Retrieves the password for the default 'Administrator' user from Kubernetes secrets. It uses `kubectl` to get the secret and `jq` to extract and decode the password. Requires `kubectl` and `jq` to be installed and configured for the Kubernetes cluster.

```bash
$ kubectl \
   --namespace  "$NAMESPACE_FOR_NUBUS" \
   get secret nubus-nubus-credentials \
   -o json | jq -r '.data.administrator_password' | \
   base64 -d
```

--------------------------------

### Get Administrator Password using kubectl

Source: https://docs.software-univention.de/nubus-kubernetes-operation/1.x/en/_sources/getting-started

Retrieves the password for the default 'Administrator' user from Kubernetes secrets. It uses `kubectl` to get the secret and `jq` to extract and decode the password. Requires `kubectl` and `jq` to be installed and configured for the Kubernetes cluster.

```bash
$ kubectl \
   --namespace  "$NAMESPACE_FOR_NUBUS" \
   get secret nubus-nubus-credentials \
   -o json | jq -r '.data.administrator_password' | \
   base64 -d
```

--------------------------------

### Debian Installer Pre-seed File Structure

Source: https://docs.software-univention.de/installation-4.0

Defines the structure of pre-seed files used for unattended Debian/Univention System Setup installations. Files must be UTF-8 encoded, and lines starting with '#' are comments. Debconf-style format is required.

```APIDOC
Pre-seed File Structure:

Encoding: UTF-8

Format: Four-column layout for debconf questions.

Columns:
  1. <owner>: The owner of the question (e.g., 'd-i' for Debian Installer).
  2. <question name>: The name of the configuration question.
  3. <question type>: The type of the question (e.g., 'boolean', 'string', 'select').
  4. <value>: The value to set for the question.

Example Line:
  owner	question_name	question_type	value

Comments:
  Lines starting with '#' are ignored.
  Empty lines are ignored.

Unattended Installation:
  All required settings must be present in the pre-seed file to ensure a fully unattended installation. Missing questions will prompt the user interactively.
```

--------------------------------

### Post-installation script for UCR variable setup

Source: https://docs.software-univention.de/developer-reference-3.2

This shell script is executed after a package installation. It uses the 'ucr set' command to automatically configure the 'atd/autostart' Univention Configuration Registry variable to 'yes', ensuring the AT daemon starts on new installations.

```shell
#!/bin/sh

#DEBHELPER#

ucr set atd/autostart?yes

exit 0
```

--------------------------------

### ID Broker Backup - Self-disclosure API Configuration

Source: https://docs.software-univention.de/idbroker-operations-manual/_sources/installation

Details the setup for a Backup Directory Node providing the Self-disclosure API. This includes joining the domain, configuring OAuth2 settings for Keycloak, and installing the necessary plugin.

```APIDOC
IDBrokerBackupSelfDisclosureAPI:
  Description: Configuration and installation steps for a Backup Directory Node running the Self-disclosure API.
  Prerequisites:
    - Primary Directory Node installation must be completed.
    - A Redis database must be available.
    - The `id-broker-backup-sddb` must be functional.
  Steps:
    1. Install a UCS "5.0-4" Backup Directory Node and join it to the Primary Directory Node's domain.
    2. Configure OAuth2 settings for Keycloak:
       - Set the `DISCLOSURE_IDP_CONFIG_VALUE` environment variable.
       - Format: `{"strategy": "oauth2", "settings": {"jwk_url": "URL", "issuer": "ISSUER", "audience": "AUDIENCE"}}`
       - `URL`: Keycloak JWK endpoint (e.g., `https://FQDN/auth/realms/$REALM_NAME/protocol/openid-connect/certs`).
       - `ISSUER`: Token issuer string (e.g., `https://FQDN/auth/$REALM_NAME`).
       - `AUDIENCE`: Consumer identifier configured in Keycloak for access tokens.
    3. Install the UCS@school APIs app:
       - Command:
         ```console
         univention-app install --username "$USERNAME" --pwdfile "$PASSWORD_FILE" ucsschool-apis
         ```
    4. Install the self-disclosure plugin:
       - Configure APT repository (similar to primary node setup).
       - Command:
         ```console
         univention-install -y id-broker-self-disclosure-api-plugin
         ```
  Related:
    - `ID_Broker_Primary_Node_Configuration`
    - `Redis_Database_Setup`
    - `UCS_School_APIs_App_Installation`
```

--------------------------------

### Profile File Structure for Unattended Installation

Source: https://docs.software-univention.de/installation-4.1

Defines the structure for profile files used in unattended Univention System Setup installations. Files must be UTF-8 encoded, and lines starting with '#' or empty lines are ignored. Debconf-style entries specify configuration settings.

```config
# Comment
<owner>	<question name>	<question type>	<value>
```

--------------------------------

### Install OX Connector with Example Settings

Source: https://docs.software-univention.de/ox-connector-app/2.1.2/_sources/installation

This example demonstrates a practical command for installing the OX Connector app with specific configuration parameters. It includes settings for administrator credentials, timezone, language, default context, and server details for SMTP, IMAP, and SOAP.

```bash
$ 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"
```

--------------------------------

### Install OX Connector with Example Settings

Source: https://docs.software-univention.de/ox-connector-app/2.1.3/_sources/installation

This example demonstrates a practical command for installing the OX Connector app with specific configuration parameters. It includes settings for administrator credentials, timezone, language, default context, and server details for SMTP, IMAP, and SOAP.

```bash
$ 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"
```

--------------------------------

### Example OX Connector Installation

Source: https://docs.software-univention.de/ox-connector-app/latest/installation

An example command demonstrating the installation of the OX Connector app with several key configuration parameters. This includes setting up master admin credentials, timezone, language, and server details for OX.

```shell
$ 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"
```

--------------------------------

### Example OX Connector Installation

Source: https://docs.software-univention.de/ox-connector-app/2.3.3/installation

An example command demonstrating the installation of the OX Connector app with several key configuration parameters. This includes setting up master admin credentials, timezone, language, and server details for OX.

```shell
$ 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"
```

--------------------------------

### Example OX Connector Installation

Source: https://docs.software-univention.de/ox-connector-app/2.3.2/installation

An example command demonstrating the installation of the OX Connector app with several key configuration parameters. This includes setting up master admin credentials, timezone, language, and server details for OX.

```shell
$ 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"
```

--------------------------------

### Example OX Connector Installation

Source: https://docs.software-univention.de/ox-connector-app/2.3.4/installation

An example command demonstrating the installation of the OX Connector app with several key configuration parameters. This includes setting up master admin credentials, timezone, language, and server details for OX.

```shell
$ 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"
```

--------------------------------

### Application Configuration File Example

Source: https://docs.software-univention.de/developer-reference-4.0

A sample configuration snippet showing basic system requirements and comments.

```config
#
#[Sizing: 5000]
#CPU=8
#RAM=32 GB
#Disk=500 GB

```

--------------------------------

### Setup LVM and Filesystems

Source: https://docs.software-univention.de/installation-3.1

Configures LVM physical volumes, volume groups, and logical volumes for swap and root filesystem. It then formats the created partitions and logical volumes with `mkfs.ext4` and `mkswap`.

```shell
mkfs.ext4 /dev/md0

lvm pvcreate /dev/md1
lvm vgcreate vg_ucs /dev/md1
lvcreate -L2G -n swap vg_ucs
lvcreate -l100%FREE -n rootfs vg_ucs

mkswap /dev/mapper/vg_ucs-swap
mkfs.ext4 /dev/mapper/vg_ucs-rootfs
```

--------------------------------

### Setup HTTP Boot Loader Symlink

Source: https://docs.software-univention.de/ext-installation/latest/en/profile

Creates a symbolic link for the HTTP-capable boot loader 'lpxelinux.0' in the client boot directory.

```shell
$ ln -s /usr/lib/PXELINUX/lpxelinux.0 \
  /var/lib/univention-client-boot/
```