Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 2.5 KB

CONFIGURE.md

File metadata and controls

37 lines (29 loc) · 2.5 KB

Intro

Config file for the checksystem is a just Perl file which returning a hash object. You can found example at cs.conf.example.

Available options:

  • hypnotoad: this hash describe the settings about hypnotoad web server. You can read details in the official documentation.
  • postgres_uri: connection string for postgres database. You can override this option by POSTGRES_URI environmental variable.
  • base_url: base url which used to create a right redirect urls. Useful if you publish scoreboard in the Internet.
  • cs.time: list of the game's periods. You must specify the time in the same time zone as the server that runs the checksystem. If you use docker deploy then specify time in UTC time zone. If you don't specify cs.time option, then the game will be endless, which can be convenient for trainings.
  • cs.round_length: length of round in seconds. Default value is 60
  • cs.flag_life_time: time of flag's life in rounds. Doesn't persist after any breaks in the game. Default value is 15.
  • cs.flags_secret: secret key for HMAC in flag's data.
  • cs.checkers.hostname: an optional callback function to detect an address of vuln's service which passed to the checkers.
  • cs.ctf_name: a name of the CTF, displayed in the scoreboard. Default vaule is CTF.
  • cs.admin_auth: a basic auth creadentials of admin page (which can be accessed by /admin route).
  • cs.scoring: this hash object describe the settings about the scoring.
  • teams: a list of the teams.
  • services: a list of the services.

teams

  • name:
  • network:
  • host:
  • logo:
  • token:
  • tags:

services

Available attributes of the service's hash:

  • name: a name of the service.
  • path: a path (absolute or relative to the root catalog of this project) to the service's main executable file.
  • timeout: an amount in seconds of checker's timeout. The service will have the status down in the current round if there is a timeout. An actual timeout for current stage (check, put, get) in the round is calculated as miniumum of the timeout from config and time prior to the start of the next round.
  • tcp_port: a main tcp port of the service.