Skip to content

Latest commit

 

History

History
67 lines (45 loc) · 3.03 KB

INSTALL.md

File metadata and controls

67 lines (45 loc) · 3.03 KB

Downloading, installing, configuring and running LARS

LARS is a Java EE application running on top of Liberty and can be configured like any other Liberty application. When LARS is installed, it creates a new Liberty server called larsServer.

Download or Build larsServer.zip

Either download larsServer.zip from IBM or build it yourself following the instructions in Building LARS

Download and install the Prerequisites

Install LARS into liberty

Unzip larsServer.zip into the WLP_USER_DIR (usually wlp/usr/) directory of an existing Liberty 19.0.0.9 (or newer) runtime.

Install LARS's pre-requisite features, using installUtility after extracting the zip: bin/installUtility install larsServer

Configure LARS

Edit the files wlp/usr/servers/larsServer/server.xml and wlp/usr/servers/larsServer/bootstrap.properties.

For a basic LARS server, you will need to configure the following:

User registry

In order to secure LARS (and it is not recommended to run LARS without security), you need a user registry. The default server.xml that is created when LARS is installed contains a <basicRegistry>, commented out, that can be uncommented and used as a starting point. For more information on configuring a user registry for Liberty, see Configuring a user registry in Liberty

HTTP endpoint

The <httpEndpoint> element determines upon which ports the LARS server will listen. You can change these ports to suit your requirements. In the default configuration, the LARS server only listens for connections from localhost (ie connections from the same host that LARS is running on). You can also add a host= attribute to cause LARS to listen for requests from other hosts. For more information on configuring Liberty's HTTP endpoint properties, see HTTP Endpoint

User to role mappings

The default server.xml configuration contains a commented-out <application-bnd> element. You can uncomment this and then customize it to your requirements. For more information on configuring authorization for applications on Liberty, see Configuring authorization for applications in Liberty.

MongoDB configuration

If your MongoDB instance uses authentication or SSL, or if other parameters such as the MongoDB port are non-default then you will need to customize the properties in bootstrap.properties.

Starting the server

  • Start mongodb
  • bin/server start larsServer

The server should now be running. Unless you've changed the default config, you should be able to visit http://localhost:9080/ma/v1/assets and see an empty list.

[]