diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md index 9e218b7..433f658 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,14 @@ The companion ~cube~ container spawned specifically for one user. - Validator for flags - Temporary secret vault for the user - control endpoint of challenge containers for the user + +## Usage + +This executable needs some parameters to work properly: + +| Key | Required? | Description | +|---|---|---| +| `-port` | No | The port for HTTP. *Default: 8080* | +| `-username` | No | Name of our user, as used e.g. in salutation. No length or charset limitation. *Default: Player 1* | +| `-accessCode` | Yes | Access code for the user. *Default: AllYourCodesAreBelongToUs* | +| `-sessionSalt` | Yes | Variable to salt the session token generator with. | |
