performance boost with meinheld and flask-minify, fixes, admin can now change user password (#76)

Author: eshaan7

.dockerignore

@@ -4,4 +4,11 @@ venv/
 .vscode/
 *.db
 .idea/
-.github/
+.github/
+.lgtm.yml
+Procfile
+app.json
+setup.cfg
+runtime.txt
+migrations/
+*.test.py

.env

@@ -0,0 +1,17 @@
+##### RTB-CTF-Framework environment variables configuration #####
+
+# Generate a psuedo-random secret with: ..
+#... python3 -c "print(__import__('secrets').token_hex(16))"                                                                                                
+SECRET_KEY=DontForgetToChangeMe
+# If serving over HTTPS, mark this True for added security
+SSL_ENABLED=False
+# about 2 x number of CPU cores
+WORKERS=4
+# Choose a strong password for administrator!
+ADMIN_PASS=admin
+# These values should be the same as specified in .env_postgres
+DB_USER=user
+DB_PASSWORD=password
+DB_NAME=rtbctf
+# Don't change
+DB_PORT=5432

.env_postgres

@@ -0,0 +1,5 @@
+# Please choose a strong password !!
+
+POSTGRES_USER=user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=rtbctf

CODE_OF_CONDUCT.md .github/CODE_OF_CONDUCT.mdCODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -2,11 +2,11 @@
 
 ### Requirements
 
-* Tested on `Python 3.8.2`
+* Tested on `Python 3.8.3`
 * Python Packages: [`src/requirements.txt`](src/requirements.txt).
 * OS Packages: PostgreSQL version 11 or greater, `libpq-dev`, `python3-dev` packages. Please refer [here](https://tutorials.technology/solved_errors/9-Error-pg_config-executable-not-found.html).
 
-### Build locally and run
+### Build locally and run (Development)
 
 1. Git clone the repo and `cd ` into it
 
@@ -22,20 +22,33 @@ $ source venv/bin/activate
 $ cd src/
 ```
 
-3. With `virtual environment` activated, install requirements, init db and run !
+3. With `virtual environment` activated, install requirements, init db,
 
 ```bash
 [venv]$ pip install -r requirements.txt 
-[venv]$ python create_db.py # Only required on first run
-[venv]$ python run.py
+[venv]$ chmod +x init_db.sh && ./init_db.sh # Only required on first run
 ```
 
-> Warning: If you make any change to [`config.py`](https://github.com/abs0lut3pwn4g3/RTB-CTF-Framework/blob/master/src/FlaskRTBCTF/config.py) logging/config class/score settings. It's highly recommended to create a new DB instance.
+4. Now we can run our application,
 
-### Docker
+    - For development server,
 
-> Note: The Docker support is not tested for production yet. It's recommended to use Heroku for production.
+    ```bash
+    [venv]$ python run.py 
+    ```
 
-```bash
-$ docker-compose up
-```
+    - Production server
+
+    ```bash
+    [venv]$ ./runserver.sh
+    ```
+
+### Docker (Production)
+
+1. Define certain environment variables present in files `.env` and `.env_postgres`.
+
+2. After having configured these environment variables, just execute,
+
+    ```bash
+    $ docker-compose up
+    ```

CONTRIBUTING.md .github/CONTRIBUTING.mdCONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -1,5 +1,6 @@
 __pycache__/
 venv/
+migrations/
 *.pyc
 .vscode/
 *.db

INSTALLATION.md .github/INSTALLATION.mdINSTALLATION.md renamed to .github/INSTALLATION.md

@@ -1,6 +1,6 @@
-FROM python:3.8.2-alpine3.11
+FROM python:3.8.3-alpine3.12
 
-MAINTAINER eshaan7bansal@gmail.com
+LABEL maintainer="eshaan7bansal@gmail.com"
 
 # Env
 RUN export DATABASE_URL="postgres://${DB_USER}:${DB_PASSWORD}@postgres:${DB_PORT}/${DB_NAME}" \
@@ -16,8 +16,8 @@ RUN adduser --shell /sbin/login www-data -DH
 # Install RTB-CTF-Framework
 WORKDIR /usr/src/app
 COPY src ./
-RUN pip install --no-cache-dir -r requirements.txt \
-    && chown -R www-data ./
+RUN chown -R www-data ./
+RUN pip install --no-cache-dir -r requirements.txt
 
 USER www-data
 

.gitignore

@@ -44,7 +44,7 @@ The 100 second elevator-pitch is that: A Capture The Flag framework; one that is
 
 ## Build locally
 
-Please see [INSTALLATION.md](INSTALLATION.md).
+Please see [INSTALLATION.md](.github/INSTALLATION.md).
 
 ## Host a customized CTF with Heroku for free in under a minute
 
@@ -83,7 +83,7 @@ The main purpose of this project is to serve as a scoring engine and CTF manager
 
 - [#rtb-ctf-framework on slack](https://rtb-ctf-framework.slack.com)
 
-Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
+Please refer to [CONTRIBUTING.md](.github/CONTRIBUTING.md)
 
 
 ## Live Demo

Dockerfile

@@ -33,6 +33,6 @@
     }
   },
   "scripts": {
-    "postdeploy": "python3 src/create_db.py"
+    "postdeploy": "bash src/init_db.sh"
   }
 }