Skip to content

Commit

Permalink
Add instruction to run natively
Browse files Browse the repository at this point in the history
  • Loading branch information
verovaleros committed Nov 3, 2024
1 parent 670b14a commit fb860b8
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ Each AIP model generates its own blocklist based on a specific criteria. The mai
- A more experimental approach to increase blocklist efficiency.


## AIP Docker
## Installation

The best way to run AIP right now is using [Docker](etc/docker/README.md).
AIP can be run through Docker (recommended) or natively. In any case, make sure the data is correctly accessible in the `data/raw/` folder and that the files `data/external/` are correctly configured.

### AIP Docker

## Usage
The best way to run AIP right now is using [Docker](etc/docker/README.md).

AIP will automatically attempt to run all the models using the available data. Assuming the Zeek data is located in its usual location:

Expand All @@ -57,6 +59,25 @@ To run AIP for a specific day:
:~$ docker run --rm -v /opt/zeek/logs/:/home/aip/AIP/data/raw:ro -v ${PWD}/data/:/home/aip/AIP/data/:rw --name aip stratosphereips/aip:latest bin/aip YYYY-MM-DD
```

### Local Installation

To run AIP locally, follow the next steps:

* Clone the AIP repository:
* `git clone https://github.com/stratosphereips/AIP.git ~/AIP`
* Access the AIP folder:
* `cd ~/AIP`
* Create a Python Virtual Environment to install the requirements
* `python3 -m venv aip-venv`
* Activate the virtual environment
* `source aip-venv/bin/activate`
* Install the Python requirements:
* `pip install -r requirements.txt`
* Set the PYTHONPATH environment variable so Python knows where to find all AIP components:
* `export PYTHONPATH=$(pwd)/lib`
* Let's test that AIP works with a simple test:
* `python3 bin/aip --help`

## License

The Stratosphere AIP tool is licensed under [GNU General Public License v3.0](https://github.com/stratosphereips/AIP/blob/main/LICENSE).
Expand Down

0 comments on commit fb860b8

Please sign in to comment.