From 15f4c3fbebddd8ac65d2af537810b332aabd8095 Mon Sep 17 00:00:00 2001 From: Fox Wilson Date: Sun, 8 Nov 2015 01:38:51 -0500 Subject: [PATCH] add installation docs, fix #1 --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5431f55 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# ctf-platform +This is the platform for TJCTF. It's (what I think is) the best of the MITRE, +CTFd, and picoCTF platforms rolled up into a Flask application. + +## Installation +You're going to want to edit `config.py`. The variable names should be fairly +self-explanatory. + +You should edit line 2 of database.py, unless you want to use SQLite. This uses +Peewee, so you can use any Peewee-supported database. + +You can create some problem YAML files that look like this: + +```yml +name: Problem Name +category: Binary +description: binary binary binary binary. i love binary +points: 250 +flags: "flag{whatever}" +``` + +Then add them with `./ctftool add-problem problem.yml` and it'll get put in the +database. + +Run `python app.py` and you have a server running. You probably want to deploy +it with `gunicorn` or similar, long-term.