diff --git a/README.md b/README.md index 309f6fb..61fb0e4 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,15 @@

-

Summary

-

Flawed Fortress is a front end platform for hosting Capture the Flag Event (CTF), it is programmed with PHP, JQuery, JavaScript and phpMyAdmin. Currently, It is designed to import SecGen CTF challenges using `marker.xml` file (which is generated in the project folder when creating a CTF Challenge)

-

Features

-

Admin Account

+## Summary + +Flawed Fortress is a front end platform for hosting Capture the Flag Event (CTF), it is programmed with PHP, JQuery, JavaScript and phpMyAdmin. Currently, It is designed to import [SecGen](https://github.com/cliffe/SecGen) CTF challenges using **`marker.xml`** file (which is generated in the project folder when creating a CTF Challenge) + +## Features + +#### Admin Account * Create Teams * Generate Tokens (Allow players to register with their preferred logins) @@ -23,43 +26,45 @@ * Export Team Tokens as PDF file * Export Username & Password as PDF file -

User Account

+#### User Account -* Team Scoreboard -* Team Activity -* Team Chat -* View Other Team Progress -* Challenges are represented as country map -* Live Timer -* Live Notification Update (For Scoreboard, Team, Chat, Flag, Announcement, Timer and Hints) +* _Team Scoreboard_ +* _Team Activity_ +* _Team Chat_ +* _View Other Team Progress_ +* _Challenges are represented as country map_ +* _Live Timer_ +* _Live Notification Update (For Scoreboard, Team, Chat, Flag, Announcement, Timer and Hints)_ -

Installation

+## Installation -

Step 1

+### Step 1 ```sql Create database in `phpMyAdmin` with secure db_username and db_password ``` -

Step 2

+### Step 2 ``` git clone https://github.com/rgajendran/ctf_marker.git ``` -

Step 3

+ +### Step 3 ```php ``` -

Open the project folder, navigate to template/connection.php file and update with your server/database login credentials.

-

Step 4

+Open the project folder, navigate to **[template/connection.php](https://github.com/rgajendran/ctf_marker/blob/master/template/connection.php)** file and update with your server/database login credentials. + +### Step 4 Transfer the entire project folder to your server domain `eg.www/` -

Step 5

+### Step 5 Navigate to Admin Account `http://DOMAIN_NAME/admin.php` @@ -69,7 +74,9 @@ Navigate to Admin Account `http://DOMAIN_NAME/admin.php` You don't need any username or password to access `admin.php` page for the first time. -

Step 6

Create Database
+### Step 6 + +##### Create Database Flawed Fortress front end has the capability to auto generate all required tables automatically in a click of a button. @@ -83,7 +90,8 @@ Click > Create (Scoreboard, Updater & Options Table) Click > Create (Users & Teams Table) Click > Create (SecGen Map Table) ``` -

Step 7

+ +### Step 7

@@ -91,11 +99,11 @@ Click > Create (SecGen Map Table) Once you create all the tables, Select SYSTEM STATUS tab in the admin account to check if there are any table errors. -

Step 8

+### Step 8 After creating `Users & Team Table`, the page will automatically redirect you to index.php (To secure the admin account). Direct access using `http://DOMAIN_NAME/admin.php` will be restricted. You would need default login details to get admin access. You can change the password after logging in. -

Default Admin Login Details

+#### Default Admin Login Details ``` Username : admin @@ -103,38 +111,18 @@ Username : admin Password : admin ``` -

Usage

- -*

Step 1

- - * Login to admin account and create teams. - -*

Step 2

- - * Choose registration method (Generate `Tokens` or `Username and Password`). - -*

Step 3

- - * Export login credential as PDF and distribute with team players. - -*

Step 4

- - * Import SecGen challenges (Import same challenges for all the registered teams or Import seperate challenges for every single team) - -*

Step 5

- - * Set Game End Timer - -*

Step 6

- - * Allow Users Login - -*

Step 7

+## Usage - * Start your Game +1. Login to admin account and create teams. +2. Choose registration method (Generate `Tokens` or `Username and Password`). +3. Export login credential as PDF and distribute with team players. +4. Import SecGen challenges (Import same challenges for all the registered teams or Import seperate challenges for every single team) +5. Set Game End Timer +6. Allow Users Login +7. **Start your Game** -

Contributing

+## Contributing 1. **Fork** the repository on GitHub 2. **Clone** the project to your own machine ```git clone https://github.com/rgajendran/ctf_marker.git```