Installation

First head to Resources and download the latest version of projectkeep.jar and the launch scripts for your platform

A local installation requires to:

  • Copy projectkeep.jar onto your system, typically into [NotesData]/keep
  • Optional: Set some environment variables (see Configuration for details)
  • use a start script (Windows server: [addin task}(administration-win.md)) from resources

Note

CHeck the installation instrctions for servers below, installation location might differ


You don’t need a separate Java runtime. DominoKEEP uses the JVM provided by Notes or Domino.


Note

When you run Keep on a client, you MUST set the environment variable GodMode=true to have local login!



Note

“Contribute to DominoKEEP” When you want to develop with DominoKEEP (contribute or extend), you need a Java8 JDK and a matching setup. FOllow those steps


Windows

Please check the Windows administration page

Linux

We use Daniel Nashed’s Linux startup script and provide poststartup.sh and preshutdown.sh scripts to interact with the keep runtime. See the source repository and Daniel’s documentation for it.

On Linux install keep in /opt/hcl/keep

Docker

First you need to build a Domino 11.0.1 image using the info available on GitHub.com. Thereafter you can build a production or debug Docker image. Not for the faint of heart

Mac

Use the the script from Resources. The script presumes a standard HCL Notes install (not an IBM upgraded with IBM in the path names). If your locations are different - carefully edit it to your needs

MacOS “Catalina” requires to give Java full disk access

Local User

After installing Keep local, on first run the database KeepConfig.nsf gets created if it does not exist. It contains one local user John Doe who is not active. You can use the Notes client, open the newly created KeepConfig.nsf look for the User entry “John Doe” to set him to active. His password is password.

John Doe