mirror of
https://github.com/ail-project/ail-framework.git
synced 2024-11-10 08:38:28 +00:00
Installation of AIL simplified and documentation updated
This commit is contained in:
parent
5ffaff7fc4
commit
98caa6b7c9
1 changed files with 8 additions and 128 deletions
136
README.md
136
README.md
|
|
@ -12,11 +12,9 @@ AIL is a modular framework to analyse potential information leaks from unstructu
|
|||
|
||||
AIL framework screencast: https://www.youtube.com/watch?v=9idfHCIMzBY
|
||||
|
||||
Requirements & Installation
|
||||
---------------------------
|
||||
Installation
|
||||
------------
|
||||
|
||||
Auto installation
|
||||
-----------------
|
||||
Type these command lines for a fully automated installation and start AIL framework
|
||||
```
|
||||
git clone https://github.com/CIRCL/AIL-framework.git
|
||||
|
|
@ -29,131 +27,14 @@ cd ~/AIL-framework/
|
|||
cd bin/
|
||||
./LAUNCH.sh
|
||||
```
|
||||
The default [installing_deps.sh](./installing_deps.sh) is for Debian and Ubuntu based distribution. For Arch
|
||||
linux based distribution, you can replace it with [installing_deps_archlinux.sh](./installing_deps_archlinux.sh).
|
||||
|
||||
Manual installation
|
||||
-------------------
|
||||
As AIL is based on python, obviously an installation of python is a requirement:
|
||||
``sudo apt-get install python2.7``
|
||||
There is also a [Travis file](.travis.yml) used for automating the installation that can be used to build and install AIL on other
|
||||
systems.
|
||||
|
||||
In addition pip, virtualenv and screen are needed:
|
||||
```
|
||||
sudo apt-get install python-pip
|
||||
sudo pip install virtualenv
|
||||
sudo apt-get install screen
|
||||
sudo apt-get install unzip
|
||||
```
|
||||
|
||||
You need to create a variable AILENV that will be the installation path:
|
||||
|
||||
``export AILENV="/home/user/AIL-framework"``
|
||||
|
||||
Usually the installation path is where the project is cloned.
|
||||
|
||||
Then create a Python virtual environment:
|
||||
|
||||
```
|
||||
cd $AILENV
|
||||
virtualenv AILENV
|
||||
```
|
||||
|
||||
And install these few more packets:
|
||||
```
|
||||
sudo apt-get install g++
|
||||
sudo apt-get install python-dev
|
||||
sudo apt-get install python-tk
|
||||
sudo apt-get install screen
|
||||
sudo apt-get install libssl-dev
|
||||
sudo apt-get install libfreetype6-dev
|
||||
sudo apt-get install python-numpy
|
||||
sudo apt-get install libadns1
|
||||
sudo apt-get install libadns1-dev
|
||||
sudo apt-get install libev-dev (redis-levelDB dependency)
|
||||
sudo apt-get install libgmp-dev (redis-levelDB dependency)
|
||||
```
|
||||
|
||||
Then these modules need to be install with pip inside the virtual environment:
|
||||
(Activating virtualenv)
|
||||
```
|
||||
. ./AILENV/bin/activate
|
||||
```
|
||||
|
||||
You'll need to clone langid:
|
||||
[https://github.com/saffsd/langid.py]
|
||||
And install it:
|
||||
```
|
||||
python setup.py install
|
||||
```
|
||||
|
||||
These are all the packages you can install with pip:
|
||||
|
||||
```
|
||||
pip install redis
|
||||
pip install logbook
|
||||
pip install pubsublogger
|
||||
pip install networkx
|
||||
pip install crcmod
|
||||
pip install mmh3
|
||||
pip install dnspython
|
||||
pip install pyzmq
|
||||
pip install texttable
|
||||
pip install -U textblob
|
||||
python -m textblob.download_corpora
|
||||
pip install python-magic
|
||||
pip install numpy
|
||||
pip install flask
|
||||
pip install nltk
|
||||
pip install whoosh
|
||||
pip install matplotlib ----- (sudo ln -s freetype2/ft2build.h in /usr/include/)
|
||||
pip install pybloomfiltermmap ----- (you may need to sudo apt-get install libssl-dev)
|
||||
pip install ipaddress
|
||||
pip install http://adns-python.googlecode.com/files/adns-python-1.2.1.tar.gz
|
||||
pip install https://github.com/trolldbois/python-cymru-services/archive/master.zip
|
||||
```
|
||||
|
||||
Installing Redis & Level DB
|
||||
---------------------------
|
||||
|
||||
Assuming that you install everything under /opt/ with adequate permissions:
|
||||
|
||||
```
|
||||
wget http://download.redis.io/releases/redis-2.8.12.tar.gz
|
||||
tar -xvf redis-2.8.12.tar.gz -C /opt/
|
||||
```
|
||||
And follow the README after extraction.
|
||||
|
||||
When redis is properly installed you can edit your own config files for
|
||||
the different required databases or just take the config from the project
|
||||
located under ``/config/``
|
||||
|
||||
```
|
||||
git clone https://github.com/KDr2/redis-leveldb.git
|
||||
```
|
||||
Follow the redis-leveldb README.
|
||||
|
||||
Then create these directories
|
||||
|
||||
```
|
||||
cd $AILENV
|
||||
mkdir PASTES
|
||||
mkdir Blooms
|
||||
mkdir dumps
|
||||
|
||||
mkdir LEVEL_DB_DATA
|
||||
cd LEVEL_DB_DATA/
|
||||
mkdir 2014
|
||||
mkdir 2013
|
||||
```
|
||||
|
||||
Starting AIL
|
||||
------------
|
||||
|
||||
If you installed all the requirements described above, you should be able to start AIL framework:
|
||||
|
||||
```
|
||||
cd $AILENV
|
||||
cd bin
|
||||
./LAUNCH.sh
|
||||
```
|
||||
Starting AIL web interface
|
||||
--------------------------
|
||||
|
||||
To start with the web interface, you need to fetch the required Javascript/CSS files:
|
||||
|
||||
|
|
@ -185,7 +66,6 @@ If you want to add a new processing or analysis module in AIL, it's simple.
|
|||
2. Use [./bin/template.py](./bin/template.py) as a sample module and create a new file in bin/ with the module name used in the modules.cfg configuration.
|
||||
|
||||
|
||||
|
||||
Redis and LevelDB overview
|
||||
--------------------------
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue