8.2.1. Introduction

This tutorial gives an overview of the most important configuration concepts. There are separate tutorials describing specific aspects in more detail.

This tutorial is about how Airlock IAM is configured in general and not about how to configure specific features.

The Config Editor

The most important tool to configure almost everything is the Config Editor.

The Config Editor has the following main features:

  • Almost all behavior of all Airlock IAM components are configured in it.
  • All changes can be applied at run-time without session loss.
  • It allows to edit, save, restore, apply and reset configurations.
  • It offers features for staging, context-dependent configuration elements, and storing secret values externally.

To access the Config Editor:

  • Log on to the Adminapp as administrator: click on the link "Config Editor" in the Admintool
  •  The administrator must have the right to view or edit the configuration (if you accessed this tutorial from the Adminapp, you should have enough rights for the Config Editor)

The following table explains the most important icons of the Config Editor:

Icon(s)
Description
Compile48np.png
Activate configuration changes.
UndoBlue48np.png
Display the currently active (running) configuration.
BlankDocumentUp48np.png/BlankDocumentDown48np.png
Upload a configuration from a file / download as a file (XML format).
Save48np.png/History24np.png
Save a working copy / restore from a working copy.
loginkeygear48np
Opens a dialog used to manage sensitive configuration values stored in an external key store.
Information48np.png
Display context help. Hint: Click on an info icon, to see the documentation in the "Docs" panel at the bottom. 
ButtonRightBlue48np.png
Go to the details page of the linked plugin.
DatabaseRecordAddBlue48np.png/DatabaseRecordDelete48np.png
Add/remove row in a list.
AddDocumentBlue48np.png
Creates a new sub-plugin configuration.
SpellCheck48np.png
Opens a regular expression tester. Properties which allow the use of regular expressions have this icon.
LoginKey48np.png
Opens a dialog to change a secret value, e.g. a password.
Lightning48np.png
Test the configuration (e.g. try to open specified connection or verify the entered username and password).
defaultValue48np.png
Indicates that this property is using the default value (because no different value has been specified by the user).
DeleteRed48np.png
Resets a value (may result in the default value being displayed and used).

For a more detailed tutorial, please consult the 9.4. IAM Config Editor (UI).

Airlock IAM instance configuration

Some fundamental settings of an instance cannot be configured in the Config Editor. These are referred to as "application parameters". They are configured in the instance properties file or using the environment. It is also worth noting that application parameters are only applied on start-up and changing those values requires Airlock IAM to be restarted.

The file instance.properties can be found in the instance directory (e.g. <configuration-dir>/instances/auth/instance.properties).

Most importantly, these parameters can be configured:

Please refer to the documentation in the file for detailed information. See also 8.1. Application parameters.

To get an up-to-date template including documentation and current default values run:

iam default-parameters