Skip to content

Commit 4c47df9

Browse files
committed
Update README.md
1 parent 4cf05cb commit 4c47df9

File tree

2 files changed

+11
-18
lines changed

2 files changed

+11
-18
lines changed

README.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -52,28 +52,19 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
5252

5353
Please see [INSTALLATION.md](INSTALLATION.md).
5454

55-
## Host Your Own CTF In 5 minutes with Heroku
55+
## Host Your Own CTF in a minute with Heroku
5656

57-
Using this is as simple as anything.
57+
1. Sign up on [Heroku](https://heroku.com), if you haven't already and click on the below "Deploy to Heroku" button.
5858

59-
1. Fork the `master` branch and clone your fork,
60-
61-
```bash
62-
$ git clone https://github.com/<your_github_username>/RTB-CTF-Framework
63-
$ cd RTB-CTF-Framework/
64-
```
65-
66-
2. Configure your CTF settings (such as name, running time) in [`config.py`](https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/blob/master/src/FlaskRTBCTF/config.py).
67-
68-
3. In the `app.json`, change the `repository` key's value to match your fork's URL.
69-
70-
4. Push these changes to the remote of your fork.
59+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
7160

72-
5. Visit your Fork's GitHub URL in the browser and click on the following **Deploy to Heroku** button.
61+
2. Give your application an awesome name and _optionally_ specify mail environment variables.
7362

7463
> Note: A psuedo-random password for the **admin** user would be created and set in the config variable `ADMIN_PASS`. On Heroku, you can reveal this password from your application's dashboard settings. Same for the Flask application's `SECRET_KEY`.
7564
76-
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
65+
3. Open your newly deployed application in the browser, you'll be redirected to login as the `admin` user and do so.
66+
67+
4. Finally, you'll want to `/setup` the CTF Settings and,
7768

7869
#### Yay! Now you have a customized instance of the RTB-CTF-Framework live on Heroku. 🎉
7970

app.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@
2222
"generator": "secret"
2323
},
2424
"MAIL_USER": {
25-
"description": "Username for mail service"
25+
"description": "Username for mail service",
26+
"required": false
2627
},
2728
"MAIL_PASS": {
28-
"description": "Password for mail service"
29+
"description": "Password for mail service",
30+
"required": false
2931
}
3032
},
3133
"scripts": {

0 commit comments

Comments
 (0)