From 0c369619b22eb2b77ab96065e094b925d930a64e Mon Sep 17 00:00:00 2001 From: kske Date: Mon, 19 Oct 2020 08:51:01 +0200 Subject: [PATCH] Add client configuration page --- Client-Configuration.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Client-Configuration.md diff --git a/Client-Configuration.md b/Client-Configuration.md new file mode 100644 index 0000000..60b44f0 --- /dev/null +++ b/Client-Configuration.md @@ -0,0 +1,22 @@ +In addition to the settings, Envoy Client offers a static configuration that can be manipulated in two different ways: + +1. By modifying the `client.properties` file inside the Envoy Client JAR file +2. By passing command line arguments to Envoy Client on startup + +The `client.properties` file specifies defaults for all configuration values. +When a value is missing, an error message will be displayed and Envoy won't start. + +Each configuration value has a name and an abbreviation, both of which can be used interchangeably. +At the moment, the following configuration values are offered: + +| Name | Shorthand | Description | Default Value | +| --------------------- | --------- | --------------------------------------- | ------------- | +| `homeDirectory` | `home` | where the client stores all of its data | `~/.envoy` | +| `fileLevelBarrier` | `fb` | The logger level for the log file | `OFF` | +| `consoleLevelBarrier` | `cb` | The logger level for the console logger | `FINER` | +| `server` | `s` | The server to connect to | `localhost` | +| `port` | `p` | The port to connect to | `8080` | +| `localDBSaveInterval` | `db-si` | Auto-save interval in minutes | `2` | + +Refer [here](https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html) for logger levels. +