Skip to content
Kevin Chung edited this page Jul 24, 2020 · 23 revisions

CTFd logo

Welcome to CTFd — the easy to use CTF framework that powers CSAW CTF.

NOTICE: This wiki is deprecated! Please visit the new documentation site!

This wiki is where you can find information on deploying CTFd and efficiently running your CTF.

Basic Installation:

  1. ./prepare.sh to install dependencies using apt.
  2. Modify CTFd/config.py to your liking.
  3. Use python serve.py in a terminal to drop into debug mode.
  4. Here are some Flask deployment options.
  5. Here are some deployment options for CTFd.
  6. You can check out the Getting Started guide for a breakdown of some of the features you need to get started.

Plugins

CTFd supports the loading of plugins which can modify the Flask app without modifying the main application. These can be dropped into the plugins folder which will be loaded on application start.

If you're interested in developing a plugin, you can read more about the plugin architecture on the Plugins page.

Here are some example plugins:

Themes

CTFd supports themes! If you modify the original theme and throw it into the themes folder, you will be able to change the theme from the admin configuration panel. The admin panel itself can also be customized by modifying the admin theme folder.

A repository to track open source CTFd themes is available here. Premium CTFd themes are available here