JohnHammond
/
CTFd
mirror of https://github.com/JohnHammond/CTFd.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs scoring page (#1049) 

* Bump docs version to 2.1.3.
* Add documentation on scoreboard integrations. 
* Add logo to documentation.
selenium-screenshot-testing
Kevin Chung 2019-07-04 12:11:10 -04:00 committed by GitHub
parent 8b3bb92c9d
commit 78fee9667a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -26,7 +26,7 @@ author = u'Kevin Chung'
# The short X.Y version
version = u''
# The full version, including alpha/beta/rc tags
release = u'2.1.2'
release = u'2.1.3'
# -- General configuration ---------------------------------------------------

5
docs/index.rst
View File

@ -6,6 +6,10 @@
CTFd
====
.. image:: https://raw.githubusercontent.com/CTFd/CTFd/master/CTFd/themes/core/static/img/logo.png
:width: 400
:alt: CTFd Logo
CTFd is a Capture The Flag framework focusing on ease of use and customizability.
CTFd comes with most of the features needed by an event organizer to run a competition or workshop. In addition, if CTFd's feature set is insufficient, CTFd allows for the usage of plugins and themes to control almost every aspect of how it looks and behaves.
@ -23,6 +27,7 @@ CTFd is written in Python and makes use of the Flask web framework.
deployment
configuration
scoring
themes
plugins
contributing

40
docs/scoring.rst Normal file
View File

@ -0,0 +1,40 @@
Scoring
=======
Scoring is central to any CTF. CTFd automatically generates a scoreboard that automatically resolves ties and supports score freezing. CTFd supports two models which can alter the score of a user or team.
Solves
------
Solves are what mark a challenge as solved. Solves do not carry a value and defer to the value of their respective Challenge.
Awards
------
Awards have a value defined by their creator (usually an admin). They can be used to give a user/team arbitrary (positive or negative) points.
Tie Breaks
----------
In CTFd, tie breaks are essentially resolved by time. If two teams have the same score, the team with the lower solve ID in the database will be considered on top. For example Team X and Team Y solve the same challenge five minutes apart and both now have 100 points.
Team X will have a Solve ID of 1 for their submission and Team Y will have a Solve ID of 2 for their submission.
Thus Team X will be considered the tie winner.
Formats
-------
MajorLeagueCyber
~~~~~~~~~~~~~~~~
MajorLeagueCyber is a cyber security event tracker designed and maintained by the developers of CTFd. It provides polling of the CTFd API and can record and aggregate scores between competitions/events. It supports parsing and processing of CTFd's built in scoreboard API format.
CTFTime
~~~~~~~
In prior versions CTFd supported a CTFTime compatible scoreboard. This is no longer directly supported because the CTFTime scoreboard format is inherently limiting. However, MajorLeagueCyber (MLC) allows for the polling of any JSON scoreboard API and can translate to the CTFTime scoreboard format. To register your event with MLC:
1. Register an account at https://www.majorleaguecyber.org/ if you don't already have one.
2. Create a new event.
3. Edit the event and add the API Scoreboard URL under the Integrations section. For CTFd you should enter ``https://[CTFd Instance URL]/api/v1/scoreboard``
4. Access the legacy scoreboard format by going to ``https://www.majorleaguecyber.org/events/[EVENT_ID]/[EVENT_NAME]/scoreboard``