search

google / ctfscoreboard

Scoreboard for Capture The Flag competitions.
Apache License 2.0
166 stars 61 forks source link

Document all configuration options #153

Open Matir opened 6 years ago

Matir commented 6 years ago

We should have a document with all configuration options documented.

keesL commented 6 years ago

Most of them can be found in ...ctfscoreboard/scoreboard/config_defaults.py. There isn't a lot of documentation, but the configuration keys are generally pretty self-explanatory. When I get around to it, I'll gladly document a few. Here is the first one:

GAME_TIME = (None, None)

The first value in the tuple is the starting time of the game, and the second is the ending time. If you want to set either (or both) Replace None by a formatted string, such as "4/8/2018 23:59". You'll get a countdown clock for free!