Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 3.08 KB

README.md

File metadata and controls

72 lines (55 loc) · 3.08 KB
Raw

rainmap-lite

Rainmap Lite - Responsive web application that allows users to launch Nmap scans from their mobiles/tablets/web browsers!

Unlike it's predecessor [1], Rainmap-lite does not require special services (RabbitMQ, PostgreSQL, Celery, supervisor, etc) to make it easy to install on any server. You simply need to install the Django application and add the cron polling task to set up a new scanning server. Nmap scans on the road for everyone!

[1] Rainmap - https://nmap.org/rainmap/

Features

  • Easily launch Nmap scans with a few clicks.
  • Responsive interface runs smoothly from your phone/tablet.
  • Reports delivered by email in all formats.
  • View reports from your web browser.
  • Schedule scans.
  • Dozens of scanning profiles to choose from.
  • Easy to install/set up.
  • Share results with your team.
  • Compatible with Python 3 (Tested on Python 3.7.4)

This project is still in beta version. Any feedback, bug reports and PRs are greatly appreciated!

Demo

https://youtu.be/3oNegHPBd3o

Documentation

You can find all the documentation related to this project on the Wiki

Installation

  1. Make sure the python3, pip3, nmap, nmap-scripts and cron installed on system
  2. git clone this project
  3. Rename/Copy the .env.sample to .env
  4. Prepare the environment file (.env)
  5. sh setup.sh

Environment variables (.env.sample file)

Configuration for setup.sh

  • APP_ROOT_PATH="/opt/rainmap-lite/"
  • HTTP_PORT="8000"
  • LOG_PATH="/var/log/nmaper.log"
  • ADMIN_USER="admin"
  • ADMIN_PASS="admin"
  • ADMIN_EMAIL="[email protected]"

Config for namper-cronjob.py

Please follow the format that described in python-dotenv

  • BASE_URL="http://127.0.0.1:${HTTP_PORT}"
  • SMTP_USER="SMTP_USER"
  • SMTP_PASS="SMTP_PASS"
  • SMTP_SERVER="SMTP_SERVER"
  • SMTP_PORT="SMTP_PORT"
  • SMTP_DOMAIN_NAME="SMTP_DOMAIN_NAME"

Screenshots

  • Responsive interface

* Customizable

* Scanning profiles

* Site Administration allows managements of users, scanning profiles and scans

* Cron based

* Results delivered by email