No description
Find a file
pandakewt ba73a97f14
Some checks failed
Linting / Linting (push) Has been cancelled
CTFd MySQL CI / Python 3.9 (push) Has been cancelled
CTFd Postgres CI / Python 3.9 (push) Has been cancelled
CTFd SQLite CI / Python 3.9 (push) Has been cancelled
fix: change dependency
2025-12-12 17:58:02 +07:00
.github Bump Dependencies (#2332) 2023-07-02 17:33:58 -04:00
conf/nginx Remove extra space 2023-06-13 18:34:25 -04:00
CTFd fix: change dependency 2025-12-12 17:56:48 +07:00
migrations Add a description field to api tokens and make api tokens start with a 'ctfd_' prefix (#2337) 2023-06-22 00:20:32 -04:00
scripts Bump Dependencies (#2332) 2023-07-02 17:33:58 -04:00
tests Downgrade Werkzeug from 2.1.2 to 2.0.3 to avoid removal errors (#2384) 2023-08-05 04:16:38 -04:00
.codecov.yml Fix admin cannot modify verified status in Edit User (#777) 2018-12-04 00:35:51 -05:00
.dockerignore Limit total number of teams (#1867) 2021-06-25 23:00:40 -04:00
.eslintrc.js 3.0.0a1 (#1523) 2020-07-01 12:06:05 -04:00
.flaskenv 1.2.0 (#627) 2018-05-03 18:04:39 -04:00
.gitignore Fix translations (#2371) 2023-07-19 00:33:29 -04:00
.isort.cfg 3.0.0a1 (#1523) 2020-07-01 12:06:05 -04:00
.prettierignore Core beta (#2314) 2023-06-01 16:30:13 -04:00
babel.cfg localization support 2023-08-26 20:38:55 -07:00
CHANGELOG.md Mark 3.6.0 (#2380) 2023-08-19 02:22:59 -04:00
compose.yaml [Komodo] pandakewt: Write Stack File: update compose.yaml 2025-12-12 17:55:55 +07:00
CONTRIBUTING.md 3.0.0a1 (#1523) 2020-07-01 12:06:05 -04:00
development.txt Bump Dependencies (#2332) 2023-07-02 17:33:58 -04:00
docker-compose.yml localization support 2023-08-26 20:38:55 -07:00
docker-entrypoint.sh Switch from manage.py to flask cli in docker-entrypoint.sh (#2353) 2023-07-04 12:13:12 -04:00
Dockerfile fix: change dependency 2025-12-12 17:56:48 +07:00
export.py Add time to export filename (#1949) 2021-07-17 16:12:47 -04:00
import.py Add import export commands to manage.py (#1723) 2020-11-16 20:24:42 -05:00
LICENSE Update LICENSE 2018-07-29 03:16:54 -04:00
linting.txt Bump Dependencies (#2332) 2023-07-02 17:33:58 -04:00
Makefile Add usage instructions for make translations-init (#2373) 2023-07-22 17:07:21 -04:00
manage.py Upgrading manage.py to work with Flask 2.0 (#2361) 2023-07-11 17:38:06 -04:00
messages.pot localization support 2023-08-26 20:38:55 -07:00
package.json Mark 3.6.0 (#2380) 2023-08-19 02:22:59 -04:00
ping.py Fix remove db from connection string (#2372) 2023-07-21 12:37:53 -04:00
populate.py Cache challenge data for faster loading of /api/v1/challenges (#2232) 2022-12-05 00:10:30 -05:00
prepare.sh Fix several issues in Vagrant provisioning (#1046) 2019-09-08 13:04:48 -04:00
README.md Fixed documentation links in README.md (#2010) 2021-10-23 03:06:28 -04:00
requirements.in Bump pymysql version to 1.0.2 and simplify event timeout ping (#2392) 2023-08-16 03:23:35 -04:00
requirements.txt Bump pymysql version to 1.0.2 and simplify event timeout ping (#2392) 2023-08-16 03:23:35 -04:00
SECURITY.md Create SECURITY.md (#1942) 2021-07-09 13:05:11 -04:00
serve.py Mark 3.1.0 (#1634) 2020-09-08 00:08:35 -04:00
setup.cfg Starting to write tests 2017-01-07 02:44:31 -05:00
Vagrantfile Fix several issues in Vagrant provisioning (#1046) 2019-09-08 13:04:48 -04:00
webpack.config.js Fix regression in notification deliverability (#1659) 2020-09-20 03:05:49 -04:00
wsgi.py Fix flask run by not monkey patching for gevent in wsgi.py (#1101) 2019-09-05 19:50:52 -04:00
yarn.lock Revert "Merge pull request #2334 from CTFd/2253-alpine-js-admin-panel" (#2336) 2023-06-20 03:31:04 -04:00

CTFd MySQL CI Linting MajorLeagueCyber Discourse Documentation Status

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.

Features

  • Create your own challenges, categories, hints, and flags from the Admin Interface
    • Dynamic Scoring Challenges
    • Unlockable challenge support
    • Challenge plugin architecture to create your own custom challenges
    • Static & Regex based flags
      • Custom flag plugins
    • Unlockable hints
    • File uploads to the server or an Amazon S3-compatible backend
    • Limit challenge attempts & hide challenges
    • Automatic bruteforce protection
  • Individual and Team based competitions
    • Have users play on their own or form teams to play together
  • Scoreboard with automatic tie resolution
    • Hide Scores from the public
    • Freeze Scores at a specific time
  • 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, and banning
  • Customize everything using the plugin and theme interfaces
  • Importing and Exporting of CTF data for archival
  • And a lot more...

Install

  1. Install dependencies: pip install -r requirements.txt
    1. You can also use the prepare.sh script to install system dependencies using apt.
  2. Modify CTFd/config.ini to your liking.
  3. Use python serve.py or flask run in a terminal to drop into debug mode.

You can use the auto-generated Docker images with the following command:

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

Or you can use Docker Compose with the following command from the source repository:

docker-compose up

Check out the CTFd docs for deployment options and the Getting Started guide

Live Demo

https://demo.ctfd.io/

Support

To get basic support, you can join the MajorLeagueCyber Community: MajorLeagueCyber Discourse

If you prefer commercial support or have a special project, feel free to contact us.

Managed Hosting

Looking to use CTFd but don't want to deal with managing infrastructure? Check out the CTFd website for managed CTFd deployments.

MajorLeagueCyber

CTFd is heavily integrated with MajorLeagueCyber. MajorLeagueCyber (MLC) is a CTF stats tracker that provides event scheduling, team tracking, and single sign on for events.

By registering your CTF event with MajorLeagueCyber users can automatically login, track their individual and team scores, submit writeups, and get notifications of important events.

To integrate with MajorLeagueCyber, simply register an account, create an event, and install the client ID and client secret in the relevant portion in CTFd/config.py or in the admin panel:

OAUTH_CLIENT_ID = None
OAUTH_CLIENT_SECRET = None

Credits