Provide README / install steps / documentation

mitre-cyber-academy / ctf-scoreboard

This scoreboard allows you to host your own cybersecurity capture-the-flag (jeopardy-style or attack/defend) competition. Also includes team creation!

http://mitrecyberacademy.org/

Apache License 2.0

54 stars 29 forks source link

Provide README / install steps / documentation #117

Closed noraj closed 6 years ago

noraj commented 6 years ago

[ ] README: general description of the app, links for Install steps & documentation, licence, etc...
[ ] installation steps: provide INSTALLATION.md or provide some installation steps in the documentation
[ ] documentation: provide a documentation with installation steps, some non intuitive stuff about managing the app, dev tips, etc ...

You can find an Installation guide I made on the wiki : https://github.com/mitre-cyber-academy/registration-app/wiki/Installation

noraj commented 6 years ago

https://github.com/mitre-cyber-academy/registration-app/pull/121

rbclark commented 6 years ago

To add to this it would be wonderful to have screenshots of the scoreboard in action on the README.

noraj commented 6 years ago

Wiki: https://github.com/mitre-cyber-academy/ctf-scoreboard/wiki/Screenshots PR: https://github.com/mitre-cyber-academy/ctf-scoreboard/pull/124

noraj commented 6 years ago

You will need to help me with production steps and configuration on the wiki.

https://github.com/mitre-cyber-academy/ctf-scoreboard/wiki/Installation https://github.com/mitre-cyber-academy/ctf-scoreboard/wiki/Configuration

rbclark commented 6 years ago

I like the screenshots! As for the production steps, we normally just run on Heroku, and the app is setup in a manner where if you just push it to Heroku, link a Postgres database, link Sendgrid, and set the S3_BUCKET, S3_KEY, and S3_SECRET if you are using the VPN certificate sync functionality then everything will just work for you. We used to run on Dokku and the configuration was very similar. After using Heroku and Dokku I strongly suggest deploying the app using one of the two.

rbclark commented 6 years ago

Closing issue since I believe @noraj has addressed most of these issues.

noraj commented 6 years ago

@rbclark I agree except one point maybe. It would be so much better if you could describe parameters in config files or at least improve the Configuration wiki page. Because some stuff like in https://github.com/mitre-cyber-academy/ctf-scoreboard/blob/master/config/environments/production.rb are designed to work with Heroku, etc...

rbclark commented 6 years ago

I have added some links to useful documentation for each variable, I hope thats helpful.

noraj commented 6 years ago

@rbclark Thx