Login App Installation

This tutorial explains how to install the Login App.

Install Login App

You can either

A) download App package from the download page and install it manually
B) or – if you are a developer – use UM Kickstarter

Either way you’ll need a license that covers de.pinuts.cmsbs.Auth2 to successfully install and use the Login App. Please contact support@pinuts.de when in doubt.

A) Install manually

If you need to install into an already existing UM you probably need to perform a manual installation as described in this section.

Go to https://www.universal-messenger.de/knowledge-base/downloads and download the Login App package (ZIP file).

Unzip the file right into your UM folder (where subfolders like cmsbs-conf/ and cmsbs-work/ live):

cd UM
unzip $DOWNLOAD_DIR/LoginApp-x.y.z.zip

Restart your UM instance.

Configure and install REST Proxy

Follow https://downloads.universal-messenger.de/knowledge-base/documentation/universal-messenger/html/UM_EN/Administration/REST-proxy.html to install and configure your REST-Proxy.

Add the following endpoints to your REST-Proxy’s controller whitelist:

de.pinuts.cmsbs.lib.widget.Pi
de.pinuts.cmsbs.auth2.Auth
de.pinuts.cmsbs.auth2.Widget

B) Install using UM Kickstarter

Start a new Kickstarter project

See Install Kickstarter

umkickstarter -n de.pinuts.tutorial um

Add Auth2 as a dependency

Edit um/build.gradle to add Auth2:

dependencies {
    // ...
    runtime('de.pinuts.cmsbs:Auth2:4.7.0')
}

Configure REST Proxy

Create a file named um/rest-proxy/cmsbs-restproxy.properties that configures the REST Proxy:

Insert the following cp lines to your um/build.gradle file:

Startup UM

Let gradle install the new dependency and start your UM instance:

Login to http://localhost:8080/cmsbs as admin / admin

Create a Segment to define the authorized users

A Segment is used to define which Entries in the UM are allowed to perform a login. All members of this Segment are authorized to login.

In this example, all Entries that have an email address are authorized, but all segmentation options could be used here, e.g., inChannel('loginusers') or isSet(login_allowed).

Go to Groups / New Segment and perform the desired segmentation. After that, save your settings as new Segment named can_login:

Create Segments to represent permissions

Go to Groups / New Segment and create some Segments that will later be used to represent the different permissions a user of your web app might be granted.

Provide all of these Segments with the Semantic tag permission.

Create Login App Instance

Go to Tools / Apps / Login and Authorization and create a new instance:

Set the unique name to my-app.

Enter a Title.

Select English as the Used language.

Select the Segment named can_login as the User base.

Enter permission as the Sematic tag to identify Segments representing web user permissions.

A) Manual installation:

Set URL of the REST proxy according to your installation.

B) Installation using UM Kickstarter:

Set URL of the REST proxy to /p.

Create a user Entry

Go to Entries / New Entry and create at least one customer user Entry that…

has an email address
and a password
and is member of at least one of the “permissions” Segments you created earlier.