Run Keep

This section describes how to run the Keep APIs against your local copy of Notes Domino.

Install the Keep Jar File

First create a keep folder under the Notes Data directory (for example: c:\Notes\data\keep)

Next find a version of the project keep jar, projectkeep.jar. There are two different places to get a keep jar:

Developers

For developers looking for a reasonably recent, reasonably stable build, you will find it here:

Bring up the Resources page in the documention: https://www.projectkeep.io/keep-core/resources.html

Development Jar

Look for the heading Latest Development Release and click the link Use at your own risk.

Once the jar file downloads, copy it to your Notes keep directory (for example: c:\Notes\data\keep).

Evaluators

For Evaluators looking for an older and potentially more stable build, you will find it here:

Bring up the Releases page in Git: https://git.cwp.pnp-hcl.com/Innovation-General/domino-keep/releases

Git Keep Jar

Click the projectkeep.jar link on the latest release.

Once the jar file downloads, copy it to your Notes keep directory (for example: c:\Notes\data\keep).

Configure Keep

Once the jar file is in place, you will need to configure two enviroment variables:

Add a new variable called DYLD_LIBRARY_PATH and point it to your Notes root directory (for example: c:\Notes).

DYLD Path

Next under System variables, edit the Path variable and add a new entry pointing your Notes root directory (for example: c:\Notes).

Update Path

Run Keep

  1. Get the file “demo.nsf” from the domino-keep repo (\domino-keep\keep-core\src\test\database) and copy it to your Notes data folder (for example: c:\notes\data).

  2. Next get the file windows_run_keep.bat from the domino-keep repo (\domino-keep\keep-core\src\main\scripts) and copy it to your new Keep folder (for example c:\Notes\data\keep)

  3. Edit windows_run_keep.bat and set GodMode to true (SET GodMode=true) which will skip calling the Notes createsession code. If set to false, the createsession call will fail since Notes is not a server.

  4. Now you’re ready to start keep by double-clicking on windows_run_keep.bat in Windows Explorer or by opening a Command window and executing it from your Keep directory.

Configure a Test user

  1. If you haven’t run Keep yet, do that now (step 4 above). Running Keep will create the Keep Configuration (KeepConfig.nsf) if it doesn’t already exist.

  2. Open KeepConfig.nsf with your Notes client:

Keep Config

  1. Now select the user John Doe and click the Set available button at the top of the screen. This will ensure that the user is available for testing.

John Doe

Vaidate your Installation

  1. Run Swagger http://localhost:8880/openapi/index.html against your Keep installation.

  2. Assuming everything has been set up correctly, you should see the Keep APIs, and be able to run them.