Install

How to find ?

JLupin Platform Web Console is distributed in two ways:

  • It's included in JLupin Platform (Community & Enterprise Edition) as ready-to-deploy microservice in local repozitory (upload directory)
  • It's available in Marketplace for registered users - it's good to take a look, because new version might be available.

NOTICE that JLupin Platform Web Console is available in two versions:

  • webcontrol.zip - for JAVA 8 & 11 environment (JRE for microservices)
  • webcontrol_java9.zip - for JAVA 9 environment (JRE for microservices)

From functional (even binary) point of view - it's exactly the same application, except JVM options in its configuration file - in case of JAVA 9 the --add-modules java.xml.bind option is added.

NOTE that in the next parts of this doc the universal webcontrol.zip name is used, but it always means the right version for your environment.

How to install ?

Before you start, get the current server certificate (if you use default one, it is already onboard) and place it inside webcontrol.zip deployment unit:

webcontrol.zip
+-- webcontrol
    +-- ssl
        +-- server
            +-- serverX509Certificate.crt <-- this file should be updated (if you don't use default set of certificates)

If you would like to use custom client certificates (from security reasons - it's recommended, at least one pair for each business domain). Follow the given instructions:

  • Generate private key and CSR
openssl req -out clientX509Certificate.csr -new -newkey rsa:2048 -nodes -keyout clientPrivateKey.pk

Generating a 2048 bit RSA private key
.............+++
..............................+++
writing new private key to 'clientPrivateKey.pk'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [XX]:PL
State or Province Name (full name) []:MALOPOLSKIE
Locality Name (eg, city) [Default City]:KRAKOW
Organization Name (eg, company) [Default Company Ltd]:JLUPIN
Organizational Unit Name (eg, section) []:R&D
Common Name (eg, your name or your server's hostname) []:ebank-client
Email Address []:admin@jlupin.com

Please enter the following 'extra' attributes
to be sent with your certificate request
A challenge password []:
An optional company name []:
  • Create self-signed certificate
openssl req -x509 -sha256 -days 365 -in clientX509Certificate.csr -key clientPrivateKey.pk -out clientX509Certificate.crt
  • Update private key and certificate files inside webcontrol.zip deployment unit:
webcontrol.zip
+-- webcontrol
    +-- ssl
        +-- client
            +-- clientPrivateKey.pk <-- this file should be updated (if you don't use default set of certificates)
            +-- clientX509Certificate.crt <-- this file should be updated (if you don't use default set of certificates)
  • Update the list of authorized client certificates on the server side - copy the new certificate to appropriate JLupin Platform directory: $JLUPIN_HOME/platform/server-resources/ssl/client (probably the name should be change to avoid accidental file overwrite).

Additionally, determine if any update is needed in config.yml (this the same file as JLupin CLI Console runtime configuration file). If you've deployed multiple JLupin Platform instances on one node you need to change transmissionPort properly:

[...]
node:
  isSSL:             true
  address:           127.0.0.1
  transmissionPort:  9096         # <-- !CHANGE! (adjust to managed instance configuration)
  connectionTimeout: 1000
  readTimeout:       300000
[...]

After security resources update and (optional) config file update, you have your (due to custom certificates) instance of JLupin Platform Web Console, the rest of the process is very simple:

  • place webcontrol.zip in the default repository for your node (local / remote - doesn't matter). By default it's local repository - $JLUPIN_HOME/platform/upload directory.
  • deploy the microservice with microservice deploy webcontrol.zip command (using JLupin Platform CLI Console)
  • enjoy it at https://<hostname>:8888/webcontrol :) click here if all stuff is on your computer.

NOTICE: If you see the certificate or security error related to insecure connect - please ignore it / accept the exception. This may happen because of self-signed certificated provided by us with JLupin (you can install your own trusted if you want).

How to setup ?

The following screen should welcome you:

Figure 1. JLupin Platform Web Console welcome screen.

There are two built-in, preconfigured users:

  • admin (password: admin), which has full rights in the web console, except user management tasks.
  • useradmin (password: useradmin), which has limited right only to user management tasks

After successful login, we advice you to adjust settings to your preferences (they are related to how the state o the environment is presented):

Figure 2. JLupin Platform Web Console settings.

Now, you can start your journey with JLupin Platform Web Console - you see the environment with important parameters, all controlled by the terminal on the right. Enjoy it :)