Skip to content

Frontend styling

How do I upload a template?

Preparing git repository

Todo

When preparing the git Repository please use the proper directory structure. Make sure to create an extension-resources folder in the root folder.

1
2
3
4
5
6
7
8
9
├── extension-resources    
   ├── email-templates
   ├── messages
   ├── static
   |   ├── css
   |   ├── images
   |   └── js
   └── templates
       └── personal

Within the extension-resources folder any of the following folders can be added:

  • Email templates: contains templates for emails.
  • Messages: contains key-value messages in multiple languages.
  • Static: contains js and css, images and other static resources.
  • Templates: contains templates displayed in the frontend.

Create git repository connection

  1. Log into Onegini Customer Identity Access Manager >System > Frontend styling.
  2. The window Frontend styling opens:

    ERS1
  3. Fill in the following fields:

    Field Description
    Remote location Define the remote location to clone the Git Repository. Only https:// is supported.
    No authentication required If this option is enabled, username and password are not mandatory and the Git Repository will be public. This option is disabled by default which means that the Git Repository is private and protected by a username and password.
    Username The username for the git repository.
    Password The password for the git repository. Instead of a password a GitHub personal access token can be generated here: Personal access tokens.
  4. Click [Next: select reference]. (The form has been validated and stored.)

Select reference

  1. After completing the steps under Create Git repository connection, the Select a Reference-window opens:

    Selectareference

  2. In the 'Select a branch' or 'Select a tag' field, all the available remote tags (when working in a staging or production environment) and branches (when working in a development or testing environment) can be selected. The first tag or branch in the list will be preselected.

  3. When the correct tag or branch has been selected, click [Save]. The branch or tag is stored and sychronization will happen automatically.
  4. After saving, the overview page will be displayed:

ERS1

The overview page shows the following information:

Field Description
Clone URL The remote URL.
Authentication The authentication method, for example 'basic'.
Username The username if the authentication method is "Username and password".
Branch or Tag The selected branch or tag.
Last checked The last time the resources have been fetched from the remote repository.

Edit connection

To edit the Git repository connection click [Edit connection].

Change reference

To change the reference click [Change reference].

Synchronize

To synchronize a Git Repository, click [Synchronize] in the overview page:

ERS1

  • During synchronization the external resources (html/css/images) are fetched from the selected Git repository and stored on the server.
  • After synchronization the templates have been uploaded and can be tested, for example by loading the login page.

Important

On the production environment changes in the templates will only be visible after restarting CIM. Please ask your contact within Onegini.