Server

Prerequisites

• JRE 8 and above

• MongoDB (Tested with 4.0.3)

You can also use online MongoDB service providers to avoid setting up the database server yourself. There are popular service providers who provides free plan, including mLab and MongoDB Atlas.

1. Download latest stable release here.

Once you have downloaded the jar file, you can run it with:

java -jar labpipe-server-[version].jar --help

The helpargument provides you a list of available arguments. Details about command line arguments can be found here.

2. Initialise default configurations

java -jar labpipe-server-[version].jar init

The init function will generate the default configuration file config.ini at the directory where you run this command.

If your database can be accessed with default configuration, the initialisation process will also create three default roles operator, token and admin and assign these roles to default APIs. A default client setting record will also be created.

If your database cannot be accessed with default configuration, you can follow the configuration guide below and then run the init command again to set up default roles and accesses.

3. Configuration

For the server to function properly, you will at least set the following parameters:

Parameter	Default	Description	Required
server.port	4567	LabPipe server port
database.host	localhost	MongoDB server host
database.port	27017	MongoDB server port
database.name		MongoDB database name	Yes
database.user		MongoDB server user	Yes if your database requires authentication
database.pass		MongoDB server password	Yes if your database requires authentication
path.cache	$HOME_DIR$/labpipe	Server cache directory path

You can set the parameter value one at each time like:

java -jar labpipe-server-[version].jar config db --host=localhost

Or you can set them all together like:

java -jar labpipe-server-all.jar config db --host=yourhost --port=12345

If you want to enable email notifications on the server, you will need to set mail server parameters, details can be found here.