lkpm-cli

Global package to assist in development of LabKey modules.

Installation

Install this utility with npm (if you're using OSX, you'll need to use sudo):

npm install -g lkpm-cli

To see the available options, execute the help command:

lkpm --help

Generate Docker Compose Configuration

To generate a docker compose configuration in your current directory (it must be empty), execute the following command:

lkpm gddc .

You can pass the --help option to lkpm gddc to see the options. They are as follows:

Option |Shortcut|Description -----------|--------|----------- --envfile|-e |You can use this option to pass a path to an .env file with default values to override the generated .env file. For instance, you can create ~/docker.defaults.env containing entries for the modules source directory, usernames, and passwords, so that you don't have to manually add those values to every single generated .env file. --mode |-m |There are three modes: prd, dev, and tst. See below for more information regarding what each mode means.

There are three different modes for the LabKey docker composition to run in, that have a few differences:

• In prd and tst, the composition listens on ports 80 and 443 for HTTP and HTTPS traffic, respectively. In dev mode, the server only listens for HTTPS connections on port 8888.
• In dev mode, the composition enables the Java debugger for Tomcat listening on 5005.
• In dev mode, LabKey runs with the -ea, -Ddevmode=true, and -Ddeploy.dir=/usr/local/labkey Java options.
• In dev mode, LabKey mounts LK_MODSRC_DIR from the .env file into the LabKey docker container at /LabKey/sources to allow live development of modules.