Scripts

Scripts

There are scripts for running and shutting down Keep on a Linux Domino server in src\main\scripts.

post_startup_script

This sets up environment variables and runs keep. The environment variables are:

  • DOMINO_HOME: path to Domino installation directory (not data directory).
  • JAVA_HOME: Domino Java jvm folder.
  • DYLD_LIBRARY_PATH and LD_LIBRARY_PATH: are needed for running JAR files on Linux.
  • NOTES_ENV: whether server or client.
  • PORT and ADMINPORT: ports on which Project Keep’s HTTP servers will listen.

The final line runs the Project Keep JAR file. The > $DOMINO_DATA_PATH/logs/vertx.log 2>&1 command gives the location for the stdout logs to be written to (the first part) and to use that also for stderr (2>&1).

pre_shutdown_script

Exports the admin port and sends a curl POST request with the shutdown key in JSON, to the shutdown endpoint.

post_shutdown_script

Terminates the project Keep jar.

windows_run_keep.bat

This is designed for use with the Windows Notes Client.


NOTE

This cannot be used to run Project Keep while the Notes Client is running. You will not be able to use Notes Client while you’re using Project Keep against your local Notes install.


There are two system environment variables that need to be set. These can be accessed on Windows 10 by going to Control Panel > System > Advanced system settings > Environment Variables….

You may be able to access the “Advanced system settings” dialog by just typing “Environment Variables” in the search bar in Windows.

  1. In “User variables” section at the top, click New… and add a variable “DYLD_LIBRARY_PATH” with the value of the Domino program directory, e.g. “C:\Program Files\HCL\Domino”.
  2. In “System variables” at the bottom, double-click the “Path” variable and add a new entry pointing to the Domino program directory.

Add projectkeep.jar to a “keep” folder in your local Notes data directory.

You can now run the batch file and Keep will start.