Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs Installation.md for 0.4.0 #923

Merged
merged 3 commits into from
Sep 27, 2024
Merged

Update docs Installation.md for 0.4.0 #923

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
df1a12c
Update docs Installation.md for 0.4.0
securestep9 Sep 27, 2024
3131ab0
Update docs/Installation.md
securestep9 Sep 27, 2024
3f1a861
Update docs/Installation.md
securestep9 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions docs/Installation.md
View file
Open in desktop
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.15 or higher is required to run Nettacker. You can check the version of Python3 installed by running:
securestep9 marked this conversation as resolved.
Show resolved Hide resolved

```
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 v3.10.15 or higher you should be able to run OWASP Nettacker via command:
securestep9 marked this conversation as resolved.
Show resolved Hide resolved

`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