aljaz/CTFd
1
0
Fork 0
mirror of https://github.com/aljazceru/CTFd.git synced 2025-12-19 06:54:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add features list (#443)

Browse Source 
* Add features list to README
This commit is contained in:
Kevin Chung
2017-11-08 18:37:00 -05:00
committed by GitHub
parent 117b43e3c5
commit 650593a32c
1 changed files with 26 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -5,12 +5,34 @@
[![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/) [![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)
## What is CTFd? ## What is CTFd?
CTFd is a Capture The Flag in a can. It's easy to customize with plugins and themes and has everything you need to run a jeopardy style CTF. CTFd is a Capture The Flag framework focusing on ease of use an customizability. It comes with everything you need to run a CTF and it's easy to customize with plugins and themes.
![CTFd is a CTF in a can.](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/original/static/img/scoreboard.png?raw=true) ![CTFd is a CTF in a can.](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/original/static/img/scoreboard.png?raw=true)
## Features
* Create your own challenges, categories, hints, and flags from the Admin Interface
* Static & Regex based flags
* Users can unlock hints for free or with points
* File uploads to the server or [Amazon S3](https://github.com/CTFd/CTFd-S3-plugin)
* Limit challenge attempts & hide challenges
* Automatic submission throttling
* Scoreboard with automatic tie resolution
* Hide Scores from the public
* Freeze Scores at a specific time
* [Dynamic Scoring](https://github.com/CTFd/DynamicValueChallenge)
* Scoregraphs comparing the top 10 teams and team progress graphs
* Markdown content management system
* SMTP + Mailgun email support
* Email confirmation support
* Forgot password support
* Automatic competition starting and ending
* Team management & hiding
* Customize everything using the [plugin](https://github.com/CTFd/CTFd/wiki/Plugins) and [theme](https://github.com/CTFd/CTFd/tree/master/CTFd/themes) interfaces
* Importing and Exporting of CTF data for archival
* And a lot more...
## Install ## Install
1. `./prepare.sh` to install dependencies using apt. 1. Run `./prepare.sh` to install dependencies using apt.
2. Modify [CTFd/config.py](https://github.com/CTFd/CTFd/blob/master/CTFd/config.py) to your liking. 2. Modify [CTFd/config.py](https://github.com/CTFd/CTFd/blob/master/CTFd/config.py) to your liking.
3. Use `python serve.py` in a terminal to drop into debug mode. 3. Use `python serve.py` in a terminal to drop into debug mode.
4. [Here](https://github.com/CTFd/CTFd/wiki/Deployment) are some deployment options 4. [Here](https://github.com/CTFd/CTFd/wiki/Deployment) are some deployment options
@@ -31,5 +53,5 @@ Looking to use CTFd but don't want to deal with managing infrastructure? Check o
Looking for CTF challenges to work on? [HackerFire](https://hackerfire.com/) is a learning focused CTF built using CTFd. It features a wide variety of challenges and is updated with new content frequently. It also contains custom knowledge resources to teach newcomers about the techniques used to solve a challenge. Looking for CTF challenges to work on? [HackerFire](https://hackerfire.com/) is a learning focused CTF built using CTFd. It features a wide variety of challenges and is updated with new content frequently. It also contains custom knowledge resources to teach newcomers about the techniques used to solve a challenge.
## Credits ## Credits
* Logo by [Laura Barbera](http://www.laurabb.com/) * Logo by [Laura Barbera](http://www.laurabb.com/)
* Theme by [Christopher Thompson](https://github.com/breadchris) * Theme by [Christopher Thompson](https://github.com/breadchris)