Download

Goto to download section and get your copy of JLupin Platform Community Edition.

Install

JLupin Platform (JLP) is distributed as zip file, in contains 'platform' directory where all JLP's resources are located. To order to install JLP:

Choose the name of the destination directory (ex. jlupin). Please be advised that on Windows platform the name should not contain any whitespace characters.
Create the destination directory (ex. /opt/jlupin or c:\Program Files\JLupin). The full path leading to this directory is called JLUPIN_HOME.
Extract downloaded archive into that directory.
On Linux, please remember about proper rights for certain files:

chmod 750 platform/start/start.sh
chmod 750 platform/start/control.sh

CHECK if OpenJDK / OracleJDK is already installed on your host / computer.

Configure

Initial parameters

The initial configuration are provided by:

$JLUPIN_HOME/platform/start/configuration/setenv

where the following parameters can be useful now:

JAVA_HOME - by default JLupin Platform's start script tries to set the value automatically. Set the JAVA_HOME here when automatic mechanisms fail.
JAVA_OPTS - memory settings for Main Server' JVM process. The default value is enough for most use cases. Increase it only in case of performance issues and after consulting with support service.

If you want to get to know all possibilities read this chapter please

Now, JLP is ready to serve :)

Run and manage

How to start ?

Windows: %JLUPIN_HOME%\platform\start\start.cmd
Linux: $JLUPIN_HOME/platform/start/start.sh

Easy, isn't it ? :)

How to check ?

If you go through this quickstart with Community Edition you can get to the example application in microservice architecture. Enter this URL to your browser:

http://localhost:8000/exchange

You should get the following result:

The diagram also shows the traffic flow of the request coming from you (your browser) :)

If you start JLupin Platform on another node than your own workstations, modify the address in your browser accordingly.

How to manage ?

CLI Console

Execute

Windows: %JLUPIN_HOME%\platform\start\control.cmd
Linux: $JLUPIN_HOME/platform/start/control.sh

to start the CLI console in interactive mode. Run help to get the full list of available commands. The most popular use cases are presented below. The full description is available in further chapters.

NOTICE that all examples are prepared for interactive mode of the local console, in order to run it in batch mode follow the pattern:

on Windows:

control.cmd <command_with_its_parameters>

Linux:

control.sh <command_with_its_parameters>

Operate the microservice

Ok, so let's go through some use cases:

Check status of the microservice
```
> microservice status exchange-rates
```
Stop the microservice
```
> microservice stop exchange-rates
```
Start the microservice
```
> microservice start exchange-rates
```
Restart the microservice
```
> microservice restart exchange-rates
```

If you would like to execute command in scope of all microservices (ex. restart all) don't specify the name of microservice. For example, to restart all, execute:

> microservice restart *

Operate the node

Show JLupin node status
```
> node status
```
Stop JLupin Platform (and all microservices)
```
> node shutdown
```
Stop force JLupin Platform (and all microservices)
```
> node terminate
```

Web Console

You can also explore your environment using JLupin Platform Web Console. To start your journey in "Web" world you need to:

deploy webcontrol.zip (version suitable to your environment, I mean: webcontrol_java8.zip or webcontrol_java9.zip) using CLI (the files by default are located in the default repository - $JLUPIN_HOME/platform/upload)

> microservice deploy webcontrol_java8.zip

> microservice deploy webcontrol_java9.zip

and enjoy the web console opening the URL: https://localhost:8888/webcontrol (user: admin, password: admin):

If you need some more information about it, please refer to documentation.

Documentation

CONTENTS