Merge remote-tracking branch 'upstream/master' into multipleMerges

README.md

@@ -17,6 +17,9 @@ An experimental dashboard showing live data and statistics from the ZMQ of one o
 - Re-update your configuration file ```config.cfg```
 
 # Starting the System
+
+/!\ You do not need to run it as root. Normal privileges are fine.
+
 - Be sure to have a running redis server
     - e.g. ```redis-server -p 6250```
 - Activate your virtualenv ```. ./DASHENV/bin/activate```
@@ -25,6 +28,23 @@ An experimental dashboard showing live data and statistics from the ZMQ of one o
 - Start the Flask server ```./server.py```
 - Access the interface at ```http://localhost:8001/```
 
+# Debug
+
+Debug is fun and gives you more details on what is going on when things fail.
+Bare in mind running Flask in debug is NOT suitable for production, it will drop you to a Python shell if enabled, to do further digging.
+
+Just before running ./server.py do:
+
+```
+export FLASK_DEBUG=1
+export FLASK_APP=server.py
+flask run --host=0.0.0.0 --port=8001 # <- Be careful here, this exposes it on ALL ip addresses. Ideally if run locally --host=127.0.0.1
+```
+
+OR, just toggle the debug flag in start_all.sh script.
+
+Happy hacking ;)
+
 # Features
 
 ## Live Dashboard

config/config.cfg.default

@@ -55,7 +55,8 @@ channelLastAwards = lastAwards
 [RedisMap]
 db=1
 channelDisp=PicToDisplay
-pathMaxMindDB=./data/GeoLite2-City_20171003/GeoLite2-City.mmdb
+# Database updates regularly make sure to adapt date
+pathMaxMindDB=./data/GeoLite2-City_20180102/GeoLite2-City.mmdb
 path_countrycode_to_coord_JSON=./data/country_code_lat_long.json
 
 [RedisDB]

start_all.sh

@@ -1,27 +1,40 @@
 #!/bin/bash
 
 set -e
+set -x
 
 GREEN="\\033[1;32m"
 DEFAULT="\\033[0;39m"
 RED="\\033[1;31m"
 
-[ -z "$DASH_HOME" ] && echo "Needs the env var DASHENV. Run the script from the virtual environment." && exit 1;
+[ -z "$DASH_HOME" ] && echo "Needs the env var DASHENV. (Did you: . ./DASHENV/bin/activate ) Please run the script from the virtual environment." && exit 1;
+
+redis_dir="${DASH_HOME}/../redis/src/"
+if [ ! -e "${redis_dir}" ]; then
+    [ ! -f "`which redis-server`" ] && echo "Either ${DASH_HOME}/../redis/src/ does not exist or 'redis-server' is not installed/not on PATH. Please fix and run again." && exit 1
+    redis_dir=""
+fi
+
+# Configure accordingly, remember: 0.0.0.0 exposes to every active IP interface, play safe and bind it to something you trust and know
+export FLASK_APP=server.py
+export FLASK_DEBUG=0
+export FLASK_PORT=8001
+export FLASK_HOST=127.0.0.1
 
 conf_dir="${DASH_HOME}/config/"
-redis_dir="${DASH_HOME}/../redis/src/"
+
 screenName="Misp-Dashboard"
 
 screen -dmS "$screenName"
 sleep 0.1
 echo -e $GREEN"\t* Launching Redis servers"$DEFAULT
-screen -S "$screenName" -X screen -t "redis-server" bash -c $redis_dir'redis-server '$conf_dir'6250.conf; read x'
+screen -S "$screenName" -X screen -t "redis-server" bash -c $redis_dir'redis-server '$conf_dir'6250.conf && echo "Started Redis" ; read x'
 
 echo -e $GREEN"\t* Launching zmq subscriber"$DEFAULT
-screen -S "$screenName" -X screen -t "zmq-subscriber" bash -c './zmq_subscriber.py; read x'
+screen -S "$screenName" -X screen -t "zmq-subscriber" bash -c 'echo "Starting zmq-subscriber" ; ./zmq_subscriber.py; read x'
 
 echo -e $GREEN"\t* Launching zmq dispatcher"$DEFAULT
-screen -S "$screenName" -X screen -t "zmq-dispatcher" bash -c './zmq_dispatcher.py; read x'
+screen -S "$screenName" -X screen -t "zmq-dispatcher" bash -c 'echo "Starting zmq-dispatcher"; ./zmq_dispatcher.py; read x'
 
 echo -e $GREEN"\t* Launching flask server"$DEFAULT
-screen -S "$screenName" -X screen -t "flask" bash -c './server.py; read x'
+screen -S "$screenName" -X screen -t "flask" bash -c 'echo "Starting Flask Server"; flask run --host=${FLASK_HOST} --port=${FLASK_PORT}; read x'