Installation

2. Installation#

You install the Apple School Manager Connector from the App Center, like any other app. This chapter describes where you can install it, how to install it, and how to obtain the credentials that the connector needs.

2.1. Supported system roles#

You can install the connector on the following system roles:

  • Primary Directory Node

  • Backup Directory Node

  • Replica Directory Node

Caution

Install the connector on exactly one system in the domain.

Every installation uploads a complete data set and overwrites what the previous upload transferred. Two installations therefore overwrite each other’s data. If you want to synchronize additional schools, add them to the existing installation as described in Schools, or add another Apple School Manager account as described in Apple School Manager accounts.

On a school Replica Directory Node, the connector only sees the school of that node. On a central Replica Directory Node, a Primary Directory Node, or a Backup Directory Node, it sees every school in the domain.

2.2. Install the app#

  1. Open the App Center in UMC.

  2. Select Apple School Manager Connector.

  3. Click Install.

After the installation, obtain the credentials as described in the next section and enter them as described in Enter the credentials.

Note

The connector requires UCS@school in version 5.2v5 or later. The app refuses to update on a system with an older version.

2.3. Obtain the SFTP credentials#

Apple School Manager generates the SFTP user name and password for you. To find them, do the following:

  1. Sign in to Apple School Manager.

  2. Click your name in the lower-left corner and select Preferences.

  3. Select Managed Apple Accounts.

  4. Open the menu for Apple formatted CSV.

  5. Click Upload CSV.

A new frame opens and shows the SFTP account data. For background information, see Apple Inc. [3].

2.4. Enter the credentials#

  1. Store the password in /etc/asm.secret with read permission for the root user only.

    Listing 2.1 Store the password#
    $ install -m 600 /dev/null /etc/asm.secret
$ editor /etc/asm.secret

  2. Add the user name, the path of the password file, and the schools to the settings file /etc/asm-connections.json, which the installation creates without an account.

    Listing 2.2 One Apple School Manager account in /etc/asm-connections.json#
    {
    "accounts": {
        "main": {
            "username": "sftp-user",
            "password_file": "/etc/asm.secret"
        }
    },
    "schools": {
        "*": {"account": "main"}
    }
}

    The entry * in schools synchronizes every school to the account.

Settings file describes the file in detail, including how to limit the account to individual schools, how to add further accounts, and every setting for users and classes. Then continue with Configuration.

On this page