Skip to content

Commit e8a844a

Browse files
committed
Clarify docs
1 parent c768c98 commit e8a844a

File tree

4 files changed

+31
-15
lines changed

4 files changed

+31
-15
lines changed

Diff for: README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Repository, and then use your Liberty server's installUtility command
99
to install the hosted features into your server.
1010

1111
## Contents
12-
- [Downloading and building LARS](https://github.com/WASdev/tool.lars/blob/master/doc/BUILDING.md)
13-
- [Installing, configuring and running LARS](https://github.com/WASdev/tool.lars/blob/master/doc/INSTALL.md)
14-
- [Using larsClient](https://github.com/WASdev/tool.lars/blob/master/doc/LARSCLIENT.md)
12+
* [Prerequisites](doc/PREREQS.md)
13+
* [Downloading, installing, configuring and running LARS](doc/INSTALL.md)
14+
* [Using larsClient](doc/LARSCLIENT.md)
15+
* [Building LARS](doc/BUILDING.md)

Diff for: doc/BUILDING.md

+4-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
1-
# Downloading and building LARS
2-
3-
Ensure you have the following prerequisites:
4-
* [Gradle v4.10.2](https://gradle.org/releases/)
5-
* [MongoDB server](https://www.mongodb.com/download-center/community) compatible with [Java Driver v3.11](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#java-driver-compatibility)
6-
* [WAS Liberty Profile 19.0.0.9](https://developer.ibm.com/wasdev/downloads/#asset/runtimes-wlp-kernel)
7-
* Your Liberty runtime must contain the following features which can be installed using `installUtility` as follows: `bin/installUtility install cdi-1.0 servlet-3.0 passwordUtilities-1.0 jaxrs-1.1`
8-
* A Java 8 JDK
9-
10-
Either download `larsServer.zip` from the [Liberty Repository](https://developer.ibm.com/wasdev/downloads/#asset/tools-Liberty_Asset_Repository_Service) and configure `server/gradle.properties` as mentioned in the second step below or build `larsServer.zip` yourself by doing the following:
1+
# Building LARS
112

3+
* Download all the [Prerequisites](PREREQS.md)
124
* Clone this repo
135
* Rename `server/gradle.properties.template` to `server/gradle.properties` and edit to point to your MongoDB and Liberty installation directories:
146
```libertyRoot=/Users/user/Documents/wlp```
@@ -17,3 +9,5 @@ Either download `larsServer.zip` from the [Liberty Repository](https://developer
179
* Look at `test-utils/src/main/resources/config.properties` and check you are happy with the specified test ports
1810
* Launch Gradle to build the code, run the tests and produce the distribution archives: `gradle build dist`
1911
* You should now have three files in the `build/distributions` directory: `larsServer.zip`, `larsClient.zip` and `bluemixServer.zip`
12+
13+
Now `larsServer.zip` can be [installed, configured and started](INSTALL.md#install-lars-into-liberty)

Diff for: doc/INSTALL.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
1-
# Installing, configuring and running LARS
1+
# Downloading, installing, configuring and running LARS
2+
23
LARS is a Java EE application running on top of Liberty and can be
34
configured like any other Liberty application. When LARS is installed,
45
it creates a new Liberty server called `larsServer`.
56

7+
## Download or Build larsServer.zip
8+
9+
Either download `larsServer.zip` from the [Liberty Repository](https://developer.ibm.com/wasdev/downloads/#asset/tools-Liberty_Asset_Repository_Service) or build it yourself following the instructions in [Building LARS](BUILDING.md)
10+
11+
Download and install the [Prerequisites](PREREQS.md)
12+
13+
## Install LARS into liberty
14+
615
Unzip `larsServer.zip` into the `WLP_USER_DIR` (usually `wlp/usr/`) directory of an existing Liberty 19.0.0.9 (or newer) runtime.
716

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

12-
To configure LARS, edit the files `wlp/usr/servers/larsServer/server.xml` and `wlp/usr/servers/larsServer/bootstrap.properties`.
21+
## Configure LARS
22+
23+
Edit the files `wlp/usr/servers/larsServer/server.xml` and `wlp/usr/servers/larsServer/bootstrap.properties`.
1324

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

Diff for: doc/PREREQS.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## In order to run LARS you need the following prerequisites
2+
3+
* [MongoDB server](https://www.mongodb.com/download-center/community) compatible with [Java Driver v3.11](https://docs.mongodb.com/ecosystem/drivers/driver-compatibility-reference/#java-driver-compatibility)
4+
* [WAS Liberty Profile 19.0.0.9](https://developer.ibm.com/wasdev/downloads/#asset/runtimes-wlp-kernel) or newer
5+
* A Java 8 JDK
6+
7+
## To build LARS you will additionally require
8+
9+
* [Gradle v4.10.2](https://gradle.org/releases/)
10+
* Your Liberty runtime must contain the following features which can be installed using `installUtility` as follows: `bin/installUtility install cdi-1.0 servlet-3.0 passwordUtilities-1.0 jaxrs-1.1`

0 commit comments

Comments
 (0)