Skip to content

licenseSpring Integration in Admin UI

Jump to bottom
duttarnab edited this page Jan 27, 2022 · 13 revisions

License Types

The LicenseSpring platform can currently handle the following license models:

  • **Perpetual **: Once Activated, the license never expires
  • Time Limited: The license will expire at a predetermined time in the future after it has been activated
  • Subscription: The license validity is synchronized with a subscription-based billing cycle.
  • Consumption: Also known as pay-per-use or metered licensing, this allows the publisher to control a number of times a routine is run (cycles, opens etc.)

For Admin UI we are using Time Limited license Type.

License Authorization

In order to issue a license to an end-user, you have 2 options:

  • Key-based licensing: entitlements are associated with the license key. They are node-locked to the machine that it is activated on.
  • Email / Password: A license is first issued and then assigned to a user, through an email and password combination. This license is directly paired to the end-user's credentials, and is also node-locked.

For Admin UI we are using Key-based licensing license Type.

Steps Followed to use LicenseSpring in Admin UI

Open a LicenseSpring account

We have opened a free account in LicenseSpring which allows only 5000 monthly api requests and 3 products.

Create Product with LicenseSpring

Once you activate your new account, log in and click Configure Products > Add new Product. We have created Gluu Admin UI product with the license-key authorization method. Reference: https://docs.licensespring.com/docs/getting-started

Create Licenses

After the product is created, we have created 2 time-limited licenses under Gluu Admin UI product. The license-key of these licenses are used in development/testing environments.

Admin UI

  1. To enable licensing feature in Admin UI we need to provide following properties in /opt/jans/jetty/jans-config-api/custom/config/auiConfiguration.properties. This properties file is used by admin-ui plugin of config-api. Set licenseSpring.enabled property to true to enable licensing feature in Admin UI. Restart config-api.
licenseSpring.apiKey=xxxx-xxxxx-xxxx-xxxxx-xxxx
licenseSpring.productCode=xxxxxxxx
licenseSpring.sharedKey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
licenseSpring.managementKey=xxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
licenseSpring.enabled=true
  1. After licensing is enabled in Admin UI, the user will get a pop-up asking license-key on the first time visiting the admin-ui URL. If the correct license-key is submitted the application will store license meta-data on the server. There will be no pop-up asking license-key from next time onwards.

  1. After login to Admin UI, the user will be able to see license details at the Admin-->License Details menu. Users can edit license expiry date, maximum activation of license allowed from different devices and activate/deactivate license from this page

Clone this wiki locally