Skip to content

Commit

Permalink
Merge pull request #923 from OWASP/securestep9-docs-0.4.0-installatio…
Browse files Browse the repository at this point in the history
…n-patch-1

Update docs Installation.md for 0.4.0
  • Loading branch information
securestep9 authored Sep 27, 2024
2 parents 12170a3 + 3f1a861 commit ce60702
Showing 1 changed file with 16 additions and 13 deletions.
29 changes: 16 additions & 13 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

### 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
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.10

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)
PLEASE NOTE: Starting from Nettacker version 0.3.1 the support for Python2 and Python <3.10 has been dropped. If you have a requirement to use Nettacker on Python 2.x or 3.0-3.9 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:
OWASP Nettacker has dependencies on the following libraries and tools:

* libcurl4-openssl-dev
* libcurl4-gnutls-dev
Expand All @@ -27,8 +27,6 @@ OWASP Nettacker v0.0.3 has dependencies on the following libraries and tools:
* 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:


Expand All @@ -38,24 +36,29 @@ apt-get update
apt-get install -y python3 python3-dev python3-pip
pip3 install --upgrade pip3
```
Install Requirements.

Starting from version 0.4.0 Nettacker is now using Poetry Package Manager and can be installed directly from PyPI.

```
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
python3 -m venv venv
. venv/bin/activate
pip3 install nettacker
nettacker --help
```

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:
PLEASE NOTE: Python version 3.10 or higher is required to run Nettacker. 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`
If you have Python 3.10 or higher you should be able to run OWASP Nettacker via command:

`python3 nettacker.py`

or simply

`nettacker`

### 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.
Expand Down

0 comments on commit ce60702

Please sign in to comment.