**Contents**:

* [Before Installation](#before-installation)
* [Installation methods](#installation)
* [After Installation](#after-installation)


### Supported Platforms

OWASP Nettacker runs on Linux operating system (we recommend using the docker image to be able to run it on any OS). If you would like to run this on your machine you must install all dependencies and at least Python 3.9.2

PLEASE NOTE: Starting from Nettacker version 0.0.3 the support for Python2 and Python <3.9 has been dropped. If you have a requirement to use Nettacker on Python 2.x or 3.0-3.7 you can use the legacy version of Nettacker [v0.0.2](https://github.com/OWASP/Nettacker/releases/tag/0.0.2) 

### Dependencies

OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools:

* libcurl4-openssl-dev
* libcurl4-gnutls-dev
* librtmp-dev
* libssl-dev
* python3-dev
* libpq-dev (required if you wish to use PostgreSQL database)
* libffi-dev 
* musl-dev 
* make
* gcc 
* git

A `requirements-apt-get.txt` file is included with Nettacker to assist the installation of the above libraries on Debian-based OS using `apt-get`. If you are using Windows, Mac or non-Debian-based Linux distro you need to install the corresponding dependencies for your operating system first.

Before using this software, please install the requirements following the commands below:


Install Python 3 first:
```
apt-get update
apt-get install -y python3 python3-dev python3-pip
pip3 install --upgrade pip3
```
Install Requirements.

```
apt-get update
apt-get install -y < requirements-apt-get.txt
pip3 install --upgrade pip
pip3 install -r requirements.txt
pip3 install -r requirements-dev.txt
```

PLEASE NOTE: Python version 3.9.2 or higher is required to run Nettacker v.0.0.3. You can check the version of Python3 installed by running:

```
python3 -V
```

If you have Python v3.9.2 or higher you should be able to run OWASP Nettacker via command `python3 nettacker.py`


### Make your life easier using docker
To run the API server, just run `docker-compose up`. if you need to run via command line use the commands below.

```
docker-compose up -d && docker exec -it nettacker_nettacker_1 /bin/bash
```