Skip to content

Startup Properties

German Vekhorev edited this page Jul 8, 2021 · 6 revisions

About

It would be more comfortable if some of Keiko's parameters were set through the command-line rather than through configuration files. Moreover, some particular parameters cannot be stored in configuration files at all. For this reason, Keiko provides a few startup properties which you may (but not required to) use. A startup property is a Java command-line argument that you pass before -jar .... The syntax is:

  • -DparamName=value for name-value pairs, or
  • -DbooleanParam to just enable a specific boolean param (set it to true, if applicable).

Notice the D prefix before param names. It is required!

Startup parameters list

Key Value Description
keiko.workDir String — path to the directory Specifies Keiko's working directory. This is the directory where Keiko stores all its files, such as configurations, logs, and caches. The default value is "keiko". This means that by default (if you don't set this property explicitly), Keiko will use folder named keiko near the Keiko executable (in the same directory) as its working directory.
keiko.staticInspWarnsYes Boolean — true or false If set, Keiko will automatically respond to itself with "yes" (if true) or "no" (if false) to the "Proceed anyway?" question asked by the static analyses manager when non-critical warnings are detected.
keiko.notReleaseWarnYes Boolean — true or false If set, Keiko will automatically respond to itself with "yes" (if true) or "no" (if false) to the "Proceed anyway?" question asked on startup when a non-release version is detected.

Example

Let's suppose you're usually running Keiko to start your 1.16.5 Spigot server with the following command:

java -jar keiko.jar spigot-1.16.5.jar

Let's suppose you want Keiko's working directory to be /home/my-server/keiko, and you want to ignore the non-release version warnings and always continue the startup anyway. To do so, replace the original command with something like this (note: the order of parameters does not matter):

java -Dkeiko.workDir=/home/my-server/keiko -Dkeiko.notReleaseWarnYes=true -jar spigot-1.16.5.jar
Clone this wiki locally