=============================================================================
iScanner - Free Linux Anti-Malware Software
=============================================================================

		    *** http://iscanner.isecur1ty.com ***

What is iScanner?
=================

iScanner is a free linux anti-malware software. It give you the ability to customize your scan between three scan
types, and the fourth type give the ability to make full scan for the all types of files. When iScanner finishes
the scan, you will be able to review the results by clicking on "VIEW REPORTS" in the left side. The report will
provide you with a detailed listing of all the Malwares that iScanner discovered. The report will be labeled
based on the risk rating of the malwares, so it can help you figuring out what should you do first.

Scan Types:
===========

iScanner has four scan types:

	1. PHP		: iScanner will search for Malwares in PHP files.
	2. JS		: iScanner will search for Malwares in JavaScript files.
	3. HTML		: iScanner will search for Malwares in HTML files.
	4. ALL FILES	: iScanner will search for Malwares in all types of files; PHP, JS, HTML, PERL, RUBY, PYTHON.


Download:
=========

To download iScanner: git clone https://www.github.com/iSecur1ty/iScanner.git

Installation:
=============

To get started, you need to invoke setup.py but before that READ Usage/Terminal and Usage/WUI sections PLEASE.

Usage:
======

1. Terminal:
   ---------

To use iScanner through Terminal you need to follow these steps:

	1. Go to /iScanner/core/
	2. Use any text editor you want to edit config.py
	3. In the following section put your mysql-server-user and mysql-server-password between the quotation marks:

		***			   ***
			mysql_user = ""
	
			mysql_pass = ""
		***		 	   ***

	4. Go to /iScanner/web_ui/Module/
	5. Repeat step no.2 to edit web_config.py
	6. In teh following section repeat the step no.3 to put your mysql_server-user and mysql-server-password between the quoation marks:

		***			   ***
			mysql_user = ""
	
			mysql_pass = ""
		***		 	   ***

	7. To finish and get ready to use iScanner you can now invoke /iScanner/setup.py
	and through the installer put the same user and password you used in the previous steps.

	8. Done.. You can do whatever you want with iScanner now and be ready to catch some Malwares.


2. Web_User_Interface(WUI):
   ------------------------

To use iScanner through our pretty amazing WUI you need to follow these steps:

	1. Go to /iScanner/web_ui/Module/
	2. Create your user and password for the WUI by: ./ui_login USERNAME PASSWORD
	3. Go to /iScanner/web_ui
	4. start our WUI as a service to any Unused port by: ./main.py PORT
	5. Use your browser to navigate to: https://localhost:PORT
	6. Enter your WUI_User and WUI_Password you created to login
	7. Awesome WUI, right? Feel free to use it.

Dependencies
============

You need few packages so iScanner can start properly:

termcolor

python-mysqldb

web.py

License
=======

This project is licensed under the GPL.V3 License.