Skip to content

Latest commit

 

History

History
74 lines (68 loc) · 5.71 KB

InstallationGuidelines.md

File metadata and controls

74 lines (68 loc) · 5.71 KB
Raw

Installation Guidelines

Short version

Using DockerHub - Linux only

  1. Install docker & docker-compose
    • sudo apt-get update
    • sudo apt-get install docker-ce docker-compose
  2. wget https://raw.githubusercontent.com/varchashva/LetsMapYourNetwork/master/docker-compose.yml
  3. docker-compose up
  4. Browse to http://localhost:9999/core and you are set to explore the tool :)

Long version

For Linux User (Note - Below commands have been provided for Debian-based linux. For other versions of Linux change all commands accordingly)

  1. Download LMYN from GitHub and extract all to a directory like /opt/LMYN ($LMYN_HOME)
  2. Install python: sudo apt-get install python2.7
  3. Install nmap: sudo apt-get install nmap
  4. Install rabbitmq-server: sudo apt-get install rabbitmq-server
  5. Install Java Development Kit
    • Install Oracle JDK 8 (it’s a prerequisite for Neo4j database)
    • Run command java -version on terminal
    • If output with version details then jump to Neo4j installation or else continue with Java installation
    • Run below commands to install Java
      • sudo add-apt-repository ppa:webupd8team/java -y
      • sudo apt-get update
      • sudo apt-get install oracle-java8-installer
  6. Go to Neo4j download section
    • Select ‘Community Server’ section and download Linux version of Neo4j
    • Extract the downloaded file with command sudo tar -xzf neo4j-community-3.3.6-unix.tar.gz -C /opt/neo4j
    • Change to neo4j directory cd /opt/neo4j
    • Run command ./bin/neo4j console to start the neo4j server
    • Browse to Neo4j web console (http://localhost:7474) to change the default password from neo4j to Neo4j
    • Please refer Neo4j Installation Guide for any troubleshooting, if required
  7. Run command sudo pip install --trusted-host pypi.python.org -r $LMYN/LetsMapYourNetwork/requirements.txt
  8. Run RabbitMQ Server service as below
    • sudo rabbitmq-server start
  9. Run Celery as below from $LMYN_HOME directory
    • celery -A LetsMapYourNetwork -l warning
  10. Run command sudo python $LMYN_HOME/LetsMapYourNetwork/manage.py runserver 0.0.0.0:9999 --insecure
  11. Open http://localhost:9999/core in browser and explore the tool

For Windows User

  1. Download LMYN from GitHub and extract all. It is recommended to extract within Python home directory for e.g. C:\python\LMYN ($LMYN_HOME)
  2. Install python
  3. Download nmap from here and install with all default settings
  4. Download RabbitMQ-Server and install with all default settings
  5. Install Microsoft Visual Studio C++
  6. Install Oracle JDK 8 (it’s a prerequisite for Neo4j database)
    • Run command java -version on command prompt
    • If output with version details then jump to Neo4j installation or else continue with Java installation
    • Go to Oracle download section and install JDK 8 with all default settings
    • Go to JRE installation directory like C:/Program files/java/jre7/bin and create a folder ‘server’ and copy all content of folder ‘client’ to folder ‘server’
  7. Go to Neo4j download section
    • Select ‘Community Server’ section and download Windows version
    • Right click on downloaded file and click extract all to a directory like C:\neo4j
    • Open the command prompt with administrative privileges and change to extracted directory like cd C:\neo4j
    • Run command bin\neo4j console to start the neo4j server
    • Browse to Neo4j web console (http://localhost:7474) to change the default password from neo4j to Neo4j
    • Please refer Neo4j Installation Guide for any troubleshooting, if required
  8. Open command prompt with Administrative privilegs and browse to Python home directory for e.g. cd C:\python
    • Run command python -m pip install --trusted-host pypi.python.org -r $LMYN/LetsMapYourNetwork/requirements.txt
  9. Run RabbitMQ Server service as below
    • From the Windows Start menu, select All Programs > RabbitMQ Server > Start Service to start the RabbitMQ server
  10. Run Celery as below from $LMYN_HOME directory
    • celery -A LetsMapYourNetwork -l warning
  11. Use same command prompt with Administrative privileges and from Python home directory
    • Run command python $LMYN_HOME\LetsMapYourNetwork\manage.py runserver 0.0.0.0:9999 --insecure
  12. Open http://localhost:9999/core in browser and explore the tool