Change Password App Installation

Owned by Florian Wolff
Last updated: März 21, 2023
3 min read

This tutorial explains how to install the Change Password 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

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 Change Password / Passwort vergessen 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/ChangePassword-x.y.z.zip

Create a file named cmsbs-conf/conf.d/changepassword.attributes with the following content:

include: cmsbs-conf/cse/plugins/de.pinuts.cmsbs.changepassword/changepassword.attributes

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.changepassword.CPForm

  • de.pinuts.cmsbs.changepassword.Widget

  • de.pinuts.cmsbs.lib.widget.Pi

  • de.pinuts.cmsbs.lib.browser.Application

B) Install using UM Kickstarter

Start a new Kickstarter project

See Install Kickstarter

umkickstarter -n de.pinuts.tutorial um

Add ChangePassword as a dependency

Edit um/build.gradle to add Auth2:

Import attribute configuration

Create a file named um/cmsbs-conf/conf.d/changepassword.attributes with the following content:

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 Mailing Template for password reset email

Go To Tools / Mailing Templates and edit the transactional email template changepassword according to your needs.

However, be sure to include a link pointing to the change password page like this:

Create Change Password App Instance

Go to Tools / Apps / Change Password and create a new instance:

Set the unique name to my-change-password.

Enter a Title.

Select English as the Used language.

 

Change Choose email notification to the Mailing Template you just created.

Set URL to change password page to the public URL of your Change Password page.

 

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 at least an email address.

Insert HTML snippet into website

Copy the HTML snippet Copy template from the configuration wizard (see above) and paste it into your website where you wish the change password form to appear.

For a local UM Kickstarter setup you can paste it into UM/cmsbs-work/webapps/ROOT/index.html and go to http://localhost:8080/ to give it a try.