not finished

Leon Hofmeister 2020-10-20 00:18:40 +02:00
parent 0c369619b2
commit 9095294a31
1 changed files with 29 additions and 0 deletions

29
Server-configuration.md Normal file

@ -0,0 +1,29 @@
Envoy Server offers a static configuration that can be manipulated in two different ways:
1. By modifying the `server.properties` file inside the Envoy Server JAR file
2. By passing command line arguments to Envoy Server on startup
The `server.properties` file specifies defaults for all configuration values.
When a value is missing, an error message will be displayed and the server 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` |
| `enter-to-stop` | `dev-stop`| whether the server can be stopped by pressing `Enter` (should only be done when a newline can be entered, meaning a console) | `true` |
| `issueCreationURL` | `i-url` | The url where issues should be reported to. Leave empty to disable sending issue proposals. | issue page on git.kske.dev |
| `issueAuthToken` | `i-token` | The token used to authenticate to the git server storing the issues. Shouldn't be changed manually. | ` ` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `db-si` | Auto-save interval in minutes | `2` |
| `userMadeLabel` | `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.