Installation

2. Installation#

This section is for administrators and covers the installation, upgrade, and removal of the School Accounts app.

2.1. System requirements#

If you install the School Accounts app and all its dependencies on the Primary Directory Node, that system needs at least the following resources:

  • 12 GB RAM

  • 150 GB disk space

The dependencies are UCS@school, the Guardian, the Kelvin REST API, and Keycloak, see Install the app.

2.2. Install the app#

You can install the School Accounts app on a Primary Directory Node or on a Backup Directory Node that runs Univention Corporate Server (UCS) 5.2-6 with UCS 5.2 erratum 569 or later.

Your domain must meet the following prerequisites before you install the app:

  • UCS@school is installed and configured in the domain.

  • The Guardian (univention-guardian) is installed and configured on the same system as the School Accounts app. For more information, see Install the authorization engine.

  • The Kelvin REST API in version 4.1.0 or later is installed and configured on the same system as the School Accounts app. The installation and the update of the School Accounts app abort otherwise.

  • Keycloak is installed and configured in the domain as the identity provider. For more information about installing Keycloak, see the Univention Keycloak app documentation.

To install the School Accounts app from the command line, run the following command:

Listing 2.1 Install the School Accounts app from the command line#
$ univention-app install ucsschool-accounts

After the installation, users reach the app through the Univention Portal. To choose who sees the portal tile, see Choose who sees the portal tile. The tile opens the app on the first system in the domain that you install it on. To point it to another system, see Point the portal tile to another system.

2.3. Upgrade the app#

To upgrade the School Accounts app to a later version, run the following command:

Listing 2.2 Upgrade the School Accounts app from the command line#
$ univention-app upgrade ucsschool-accounts

2.4. Remove the app#

To remove the School Accounts app from a system, run the following command:

Listing 2.3 Remove the School Accounts app from the command line#
$ univention-app remove ucsschool-accounts

The removal deletes the portal tile and the policies of the app. It deletes the tile even if the app still runs on other systems, see Removing the app from one system deletes the portal tile. It keeps the Keycloak client, because other systems in the domain can still use it.

2.4.1. Remove the Keycloak client#

The School Accounts app signs users in through the Keycloak client ucsschool-accounts-ui in the ucs realm. After you remove the app from every system in the domain, you can delete that client in the Keycloak administration console at https://ucs-sso-ng.DOMAIN_NAME/admin/master/console/. Replace DOMAIN_NAME with the domain name of your UCS domain. If you have set the Univention Configuration Registry (UCR) variable keycloak/server/sso/fqdn, use its value instead of ucs-sso-ng.DOMAIN_NAME.

On this page