Using the Loginapp Design Kit command-line tool

• The Loginapp Design Kit is installed.

To initialize the Loginapp Design Kit, the path to a custom folder must be provided. This folder will contain all the files that can be used when customizing:

copy

CUSTOM_DIRECTORY=/path/to/my/custom/directory
./sdk init -d $CUSTOM_DIRECTORY

It is strongly recommended to keep customized files separate from the Loginapp Design Kit installation directory (.internal/). The separation allows for the maintenance of multiple projects (customers, instances, etc.), easier referencing of default values and painless updates. In addition, it is much simpler to put separate customizations under version control.

For the remainder of this documentation, we use $CUSTOM_DIRECTORY as a variable that points to the directory containing the customizations. This is not a requirement to work with the Loginapp Design Kit.

To start customizing and to get immediate visual feedback, the Loginapp Design Kit provides a development mode.

To run the development mode, use:

copy

./sdk dev -d $CUSTOM_DIRECTORY

After running the command, a browser will open showing a static view of the web application to make the changes immediately visible without having an actual Airlock IAM instance running. The dev mode can be terminated using CTRL+C in the shell.

The ./sdk dev command may generate security warnings. These warnings only apply to the local instance of the Loginapp Design Kit and do not affect customizations deployed to production. It is, therefore, safe to ignore these warnings.

1. Once customizing is completed, create a build for production use as follows:
copy



./sdk build -d $CUSTOM_DIRECTORY

2. A ZIP file is created at:
   $CUSTOM_DIRECTORY/build/airlock-iam-loginapp-rest-ui-customizations.zip

1. Modify the instance.properties as follows to configure the filename and location of the zip archive containing the customizations:
copy



iam.loginapp.rest.ui.customizations = instances/${instance.name}/airlock-iam-loginapp-rest-ui-customizations.zip

2. This step is needed only once and Airlock IAM must be restarted for the change to take effect.
3. Deploy the zip-file by moving it to the Airlock IAM instance directory, e.g. to:
   instances/${instance.name}/airlock-iam-login-ui-customizations.zip Replace ${instance.name} with the name of the instance (e.g. auth).
4. The IAM server automatically detects changes in the ZIP file and applies them to the running instance without restart.

Customization is done entirely in the directory $CUSTOM_DIRECTORY while running the development mode.

The most important directories and files are listed below:

src/sass/custom 

src/assets/custom/img

src/assets/custom/i18n

src/assets/custom/js

src/sdk/config