Setup and Install

Table of Contents

• Prerequisites
• Installation
  • Linux
  • Windows or Mac OSX

Prerequisites

The BASH script install_streamingphish.sh performs automatic installation on any Linux platform officially supported by Docker CE. It's been tested against the following images from DigitalOcean with no issues:

• Centos 7
• Ubuntu 16.04
• Debian 9.4
• Fedora 27

DigitalOcean droplets, AWS instances, or other cloud-based VMs with at least 2GBs of RAM should do the trick. The system exhausts almost 2GBs of RAM when training a classifier, so perhaps run on a system with 4GBs of RAM to be safe. You'll know the system ran out of memory if the container dies in the middle of computing features during training.

Installation

 git clone https://github.com/wesleyraptor/streamingphish.git
 cd streamingphish/
 sudo ./install_streamingphish.sh

Linux

Use the install_streamingphish.sh script to install on Linux platforms. This routine will build the containers and run them in detached mode (running in the background). The output should appear as follows:

[wes@centos-4-24 streamingphish]$ sudo ./install_streamingphish.sh 
[+] Detected a Linux kernel.
[+] Detected OS CentOS Linux running version 7.
[*] Attempting to install Docker via convenience script...
[*] Attempting to install Docker Compose...

[...]

Creating home_notebook_1 ... done
Creating home_db_1       ... done
Creating home_cli_1      ... done

[+] Successfully built and started the applications in daemon mode.

I suggest adding your user to the docker group so you don't have to use sudo each time, like this:
   $ sudo usermod -aG docker $(whoami)

You'll have to logout and log back in for the changes to take effect.

There are 3 services embedded within this application:
 - db
 - cli
 - notebook

Primary actions:
  1. The Jupyter notebook is currently available at <your_servers_ip_address>:9000.
  2. Run streamingphish CLI utility:
   $ docker-compose exec cli streamingphish

See the Github README for further instructions on starting/stopping services, rebuilding the containers, etc.

Windows or Mac OSX

Installation on other platforms works if docker and docker-compose are already installed. Run the following command to build and start the containers:

 sudo docker-compose up -d