Updated README, visited for nostalgia, and checked to make sure things still worked
This commit is contained in:
@@ -1,3 +1,11 @@
|
|||||||
|
correctlog.txt
|
||||||
|
.nyc_output/
|
||||||
|
coverage/
|
||||||
|
node_modules/
|
||||||
|
npm-debug.log
|
||||||
|
package-lock.json
|
||||||
|
test/*.log
|
||||||
|
|
||||||
.DS_Store
|
.DS_Store
|
||||||
# Logs
|
# Logs
|
||||||
logs
|
logs
|
||||||
|
|||||||
@@ -1,13 +1,42 @@
|
|||||||
# TinyCTF
|
# TinyCTF
|
||||||
|
|
||||||
## How to use
|
## Purpose
|
||||||
Install dependancies, see below...
|
This was originally created to be used for a CTF escape room. It works best when only one teams is competing at a time.
|
||||||
Add your teams and flags to the config.json file
|
|
||||||
Finally run app.js with node
|
|
||||||
|
|
||||||
## Requirements
|
## Adding Teams
|
||||||
`npm install colors`
|
Teams can be added via a Json object in the config file. Each team has a name and an indicated as to which one is active. Changes require server restart.
|
||||||
`npm install express`
|
|
||||||
`npm install path`
|
They use the following format...
|
||||||
`npm install body-parser`
|
```
|
||||||
`npm install ejs`
|
"teamcfg" : {
|
||||||
|
"teams" : [
|
||||||
|
{"name":"cyber1", "active":"1"},
|
||||||
|
{"name":"cyber3", "active":"0"}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
```
|
||||||
|
|
||||||
|
## Adding Flags
|
||||||
|
Flags can be added via a Json object in the config file. Each flag has a string and a point value associated with it. Changes require server restart.
|
||||||
|
|
||||||
|
They use the following format...
|
||||||
|
```
|
||||||
|
"flags" : [
|
||||||
|
{"flag":"ursneaky", "value":"1"},
|
||||||
|
{"flag":"FISHAREHOT", "value":"1"}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## TLDR Instructions
|
||||||
|
1. Install dependancies with ` npm i `
|
||||||
|
2. Add your teams and flags to the config.json file
|
||||||
|
3. Finally run app.js with ` sudo node app.js `
|
||||||
|
|
||||||
|
## Additional Notes
|
||||||
|
I am not actively working on / maintaining this repo. This was used one time and worked well for me.
|
||||||
|
If you are interested in contributing or adding features, I would be more than happy to take pull requests and become more active with this repo. Right now, there is a need for...
|
||||||
|
|
||||||
|
- [] A way to swap the active team and adding challenges without relaunching the server.
|
||||||
|
- [] A built-in scoreboard rather than a bash script that run on a log file :D
|
||||||
|
|
||||||
|
If you are hosting a CTF, I'd encourage you to take a look at the [CTFd](https://ctfd.io/) platform as it is rather well polished and has a lot of nice features.
|
||||||
Generated
+922
-128
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,26 @@
|
|||||||
|
{
|
||||||
|
"name": "tinyctf",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"description": "Local dead simple CTF website that works well for 1 team at a time.",
|
||||||
|
"main": "app.js",
|
||||||
|
"scripts": {
|
||||||
|
"test": "sudo node app.js"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/d4rkr41n/TinyCTF.git"
|
||||||
|
},
|
||||||
|
"author": "d4rkr41n",
|
||||||
|
"license": "ISC",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/d4rkr41n/TinyCTF/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/d4rkr41n/TinyCTF#readme",
|
||||||
|
"dependencies": {
|
||||||
|
"body-parser": "^1.19.1",
|
||||||
|
"colors": "^1.4.0",
|
||||||
|
"ejs": "^3.1.6",
|
||||||
|
"express": "^4.17.2",
|
||||||
|
"path": "^0.12.7"
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user