You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-4Lines changed: 12 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,10 @@
18
18
</a>
19
19
</p>
20
20
21
-
A lightweight, easy to deploy CTF framework (in Flask) for HackTheBox style machines.
21
+
A fast, efficient and lightweight (~100 KB) Capture The Flag framework (in Flask) inspired by the [HackTheBox](https://hackthebox.eu/) platform.
22
+
23
+
The 100 second elevator-pitch is that: A Capture The Flag framework; one that is fast yet feature packed, efficient thus scalable, lightweight (insert some more pro developer adjectives) and customizable to your organization's brand while not emptying your bank A/C.
22
24
23
-
The main purpose of this project is to serve as a scoring engine and CTF manager.
24
25
25
26
**Want to see it in action?**
26
27
@@ -32,7 +33,7 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
32
33
33
34
* Machines listing with fields: name, IP, OS, points and difficulty level.
34
35
* Challenges listing with fields: title, description, URL, points.
35
-
* Totally configurable settings such running time, organization details, CTF name.
36
+
* Totally configurable settings such as running time, organization details, CTF name, etc.
36
37
* Automatic strong password for administrator
37
38
* Well implemented controls for administrators providing features such as issuing notifications, database CRUD operations, full fledged logging,
38
39
* Simple User Registration/login process, account management, Forgot password functionalities,
@@ -45,7 +46,7 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
45
46
46
47
Please see [INSTALLATION.md](INSTALLATION.md).
47
48
48
-
## Host Your Own CTF in a minute with Heroku
49
+
## Host a customized CTF with Heroku for free in under a minute
49
50
50
51
1. Sign up on [Heroku](https://heroku.com), if you haven't already and click on the below "Deploy to Heroku" button.
51
52
@@ -63,6 +64,12 @@ Please see [INSTALLATION.md](INSTALLATION.md).
63
64
64
65
> Bonus: You can manage the database CRUD operations from admin views GUI; change machine settings, issue notifications to users, etc.
65
66
67
+
## Inspiration
68
+
69
+
The main purpose of this project is to serve as a scoring engine and CTF manager. One that is packed with features, can handle enterprise/global level traffic on a scalable yet [free heroku's dyno](#host-your-own-ctf-in-a-minute-with-heroku).
70
+
71
+
[CTFd](https://github.com/ctfd/ctfd) is one of the most popular CTF framework and we have used it for multiple engagements and will surely use it again. But at the same time, CTFd is heavy (~22.2 mb) (it gives poor performance even on a $49/mo heroku dyno) and nobody has $$$ to spend on cloud, especially students (like us). So, that's where RTB-CTF-Framework (~100 KB) comes in.
72
+
66
73
## Contributing
67
74
68
75
<p>
@@ -88,6 +95,7 @@ Please see [INSTALLATION.md](INSTALLATION.md).
88
95
89
96
For further guidelines, Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
90
97
98
+
91
99
## Live Demo
92
100
93
101
**Live Demo:**<https://rtblivedemo.herokuapp.com/> (login with `admin:admin`)
0 commit comments