About

The visualSHARK is a graphical frontend for the MongoDB of the SmartSHARK project. It consists of a Django based Backend and a VueJS based Frontend. Some functionality relies on a worker process which executes background tasks and a Websocket connection.

Requirements

Requirements and how to get them with Ubuntu 16.04 LTS. RabbitMQ has to be running with activated web_stomp module.

Python 3.6

add-apt-repository ppa:jonathonf/python-3.6
apt-get update
apt-get install python3.6
apt-get install python3.6-dev
apt-get install python3.6-venv

python-3.6 uwsgi module (only for production deployment)

apt-get install python3.6 python3.6-dev uwsgi uwsgi-src uuid-dev libcap-dev libpcre3-dev libssl-dev
cd ~
PYTHON=python3.6 uwsgi --build-plugin "/usr/src/uwsgi/plugins/python python36"
mv python36_plugin.so /usr/lib/uwsgi/plugins/python36_plugin.so
chmod 644 /usr/lib/uwsgi/plugins/python36_plugin.so

pygraphviz

apt-get install graphviz-dev
pip install pygraphviz --install-option="--include-path=/usr/include/graphviz" --install-option="--library-path=/usr/lib/graphviz/"

NPM

cd ~
curl -sL https://deb.nodesource.com/setup_6.x -o nodesource_setup.sh
nano nodesource_setup.sh
bash nodesource_setup.sh
apt-get install nodejs

RabbitMQ

apt-get install rabbitmq-server
systemctl start rabbitmq-server
rabbitmq-plugins enable rabbitmq_webstomp, rabbitmq_management

Installation

Install Backend

apt-get install libmysqlclient-dev
git clone https://github.com/smartshark/visualSHARK.git

cd /srv/www/visualSHARK
python3.6 -m venv .
source bin/activate
pip install -r requirements.txt

# change database credentials for MySQL DB and Mongo DB
# change secret key and, if ServerSHARK is available, URL to the endpoint and an api key.
cp sntest/settings_dist.py sntest/settings.py
nano sntest/settings.py

# migrate database
python manage.py migrate

# create superuser
python manage.py createsuperuser

Install Frontend

cd /srv/www/visualSHARK/frontend/app

# install dependencies
npm install

# change local production settings, endpoints for RabbitMQ, Websocket
cp ./config/prod.local.env.js ./config/prod.env.js
nano ./config/prod.env.js

# run frontend in dev mode
# npm run dev

# build prod version
npm run build

Operation

run backend in dev mode

cd /srv/www/visualSHARK
source bin/activate
python manage runserver

run backend worker

cd /srv/www/visualSHARK
source bin/activate
python manage peon

run frontend in dev mode

cd /srv/www/visualSHARK/frontend/app
npm run dev

benjaminLedel/visualSHARK_topicShark