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

Add missing values to server configuration page

Kai S. K. Engelbart 2020-10-20 17:37:14 +02:00
parent 9095294a31
commit 61d62dcfe8
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
Server-configuration.md

@ -9,21 +9,21 @@ When a value is missing, an error message will be displayed and the server won't
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` |
| Name | Shorthand | Description | Default Value |
| ---------------------- | ---------- | --------------------------------------------------------------- | ------------- |
| `homeDirectory` | `home` | Where the server 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 the return key on the command line | `true` |
| `issueCreationURL` | `i-url` | The url where issues should be reported to. Leave empty to disable sending issue proposals. | The 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. | (redacted) |
| `userMadeLabel` | `l-um` | The ID of the "user made" label | `272` |
| `bugLabel` | `l-b` | The ID of the "bug" label | `117` |
| `featureLabel` | `l-f` | The ID of the "feature" label | `119` |
| `enableIssueReporting` | `e-ir` | Whether to enable issue reporting | `true` |
| `enableGroups` | `e-g` | Whether to enable groups | `true` |
| `enableAttachments` | `e-a` | Whether to enable attachments | `true` |
| `authTokenExpiration` | `tok-exp` | The amount of days after which the authentication token expires | `90` |
Refer [here](https://docs.oracle.com/en/java/javase/11/docs/api/java.logging/java/util/logging/Level.html) for logger levels.