Administration guide

Thou almighty Thor Admin, this is the section just for you.


NOTE

Read this section carefully to ensure KEEP operates in line with your corporate standards and expectations


Scripts

The description explains how to start/stop KEEP on your server or client and which environment variables are set.

Logs

Logs will be written to logs/vertx.log in the Domino or Notes data directory.

Configuration

We use JSON configuration files and environment variables to define runtime behaviors:

  • Security: identity sources, token durations, CORS
  • What APIs to load
  • TLS: keys, cyphers etc

We deliberatly kept these configuration settings out of the API, AdminUI or KeepConfig.nsf. We deem them sensitive enough, to not being available remotely, but require machine access

Admin API

The endpoints that allow you to check on KEEP running itself (not the data, but the runtime). On a local machine that’s http://localhost:8889/

  • /log:shows you the KEEP Java log
  • /config: shows the actual configuration (with confidential info masked) that is the result of our config loading sequence
  • /info: shows the loaded verticles and handler classes as well as the one’s that are missing
  • /shutdown - You need to post to that one to shutdown KEEP. It requires a shutdown key in JSON
  • /reload - You need to post to that, so keep reloads. Needs the shutdown key too

NOTE

It is strongly recommended that you use your Firewall to block mere mortal access to the admin port and only allow access to it from a secure admin workstation!


Admin UI

That’s the place where you define what databases are accessible through KEEP, what views and forms are available under what conditions. The UI is there for convenience, you can handle all it does through CURL or POSTMAN calls if you like.