zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Add client configuration page

Kai S. K. Engelbart 2020-10-19 08:51:01 +02:00
parent 967edd7d85
commit 0c369619b2
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Client-Configuration.md Normal file

@ -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.