about summary refs log tree commit diff
path: root/README.md
blob: 433f658dec2179c59c401d0d8132e5c35108c0bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# circus-companion

The companion ~cube~ container spawned specifically for one user.

## Purpose

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