CTFd/README.md

![](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/core/static/img/logo.png?raw=true)
====

[![Build Status](https://travis-ci.org/CTFd/CTFd.svg?branch=master)](https://travis-ci.org/CTFd/CTFd)
[![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)

## What is CTFd?
CTFd is a Capture The Flag framework focusing on ease of use and 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/core/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
 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.
 3. Use `flask run` in a terminal to drop into debug mode.

Or you can use Docker with the following command:

`docker run -p 8000:8000 -it ctfd/ctfd`

 * [Here](https://github.com/CTFd/CTFd/wiki/Basic-Deployment) are some deployment options
 * You can check out the [Getting Started](https://github.com/CTFd/CTFd/wiki/Getting-Started) guide for a breakdown of some of the features you need to get started.

## Live Demo
https://demo.ctfd.io/

## Support
To get basic support, you can join the [CTFd Slack Community](https://slack.ctfd.io/): [![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)

If you prefer commercial support or have a special project, send us an email: [support@ctfd.io](mailto:support@ctfd.io).

## Managed Hosting
Looking to use CTFd but don't want to deal with managing infrastructure? Check out [the CTFd website](https://ctfd.io/) for managed CTFd deployments.

## HackerFire
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
 * Logo by [Laura Barbera](http://www.laurabb.com/)
 * Theme by [Christopher Thompson](https://github.com/breadchris)
Update README.md 2017-12-12 05:47:14 +00:00			`![](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/core/static/img/logo.png?raw=true)`
Initial commit 2015-01-01 05:36:56 +00:00			`====`

Update README.md Links to new repo location 2017-03-13 00:14:13 +00:00			`[![Build Status](https://travis-ci.org/CTFd/CTFd.svg?branch=master)](https://travis-ci.org/CTFd/CTFd)`
Update README.md 2016-12-13 08:37:50 +00:00			`[![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)`
Adding slack icon/link 2016-12-13 08:35:22 +00:00
Update README.md 2017-05-16 06:25:11 +00:00			`## What is CTFd?`
fixing typo in readme (#450) 2017-11-11 17:43:33 +00:00			`CTFd is a Capture The Flag framework focusing on ease of use and customizability. It comes with everything you need to run a CTF and it's easy to customize with plugins and themes.`
CTFd code push 2015-01-01 05:45:25 +00:00
Update README.md 2017-12-12 05:47:14 +00:00			`![CTFd is a CTF in a can.](https://github.com/CTFd/CTFd/blob/master/CTFd/themes/core/static/img/scoreboard.png?raw=true)`
Update README.md 2017-05-16 06:10:26 +00:00
Add features list (#443) * Add features list to README 2017-11-08 23:37:00 +00:00			`## 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...`

Use headlines in README (#249) + legibility + ability to link to section anchors directly 2017-04-20 23:27:16 +00:00			`## Install`
Add features list (#443) * Add features list to README 2017-11-08 23:37:00 +00:00			1. Run `./prepare.sh` to install dependencies using apt.
Update README.md Links to new repo location 2017-03-13 00:14:13 +00:00			`2. Modify [CTFd/config.py](https://github.com/CTFd/CTFd/blob/master/CTFd/config.py) to your liking.`
Marking 1.2.0 (#628) * Mark 1.2.0. * Update CHANGELOG. * Add `window.challenge.data` object. * Don't raise a 500 when an endpoint can't be found but was POST'ed too. Mostly from scanners... * Add test for not found endpoints. * Fixing issue with clearing logo on config update. * Truncate scoreboard team name to 50 characters. 2018-05-04 21:24:02 +00:00			3. Use `flask run` in a terminal to drop into debug mode.
Marking 1.1.3 (#599) * Version 1.1.3 2018-03-27 16:20:58 +00:00
			`Or you can use Docker with the following command:`

			`docker run -p 8000:8000 -it ctfd/ctfd`

			`* [Here](https://github.com/CTFd/CTFd/wiki/Basic-Deployment) are some deployment options`
			`* You can check out the [Getting Started](https://github.com/CTFd/CTFd/wiki/Getting-Started) guide for a breakdown of some of the features you need to get started.`
Update README.md 2015-01-01 05:52:09 +00:00
Use headlines in README (#249) + legibility + ability to link to section anchors directly 2017-04-20 23:27:16 +00:00			`## Live Demo`
Adding Reversing Module 2017-01-10 09:18:10 +00:00			`https://demo.ctfd.io/`

Update README.md 2017-10-17 08:11:56 +00:00			`## Support`
			`To get basic support, you can join the [CTFd Slack Community](https://slack.ctfd.io/): [![CTFd Slack](https://slack.ctfd.io/badge.svg)](https://slack.ctfd.io/)`

Update README.md 2017-11-13 06:45:13 +00:00			`If you prefer commercial support or have a special project, send us an email: [support@ctfd.io](mailto:support@ctfd.io).`
Update README.md 2017-10-17 08:11:56 +00:00
Update README.md 2017-07-24 02:42:40 +00:00			`## Managed Hosting`
Marking 1.1.3 (#599) * Version 1.1.3 2018-03-27 16:20:58 +00:00			`Looking to use CTFd but don't want to deal with managing infrastructure? Check out [the CTFd website](https://ctfd.io/) for managed CTFd deployments.`
Update README.md 2017-07-24 02:42:40 +00:00
Update README.md 2017-07-23 15:28:15 +00:00			`## HackerFire`
Marking 1.1.3 (#599) * Version 1.1.3 2018-03-27 16:20:58 +00:00			`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.`
Adding demo site 2015-01-02 02:16:16 +00:00
Use headlines in README (#249) + legibility + ability to link to section anchors directly 2017-04-20 23:27:16 +00:00			`## Credits`
Add features list (#443) * Add features list to README 2017-11-08 23:37:00 +00:00			`* Logo by [Laura Barbera](http://www.laurabb.com/)`
			`* Theme by [Christopher Thompson](https://github.com/breadchris)`