Skip to content

Setup

Jump to bottom
Xavier Garceau-Aranda edited this page Apr 4, 2020 · 15 revisions

Requirements

Assuming access to the desired APIs has already been configured on a machine (e.g. the provider's CLI has been set up), then installing and using Scout Suite should be trivial.

Scout Suite is written in Python and supports the following versions:

  • 3.5
  • 3.6
  • 3.7
  • 3.8

The required libraries can be found in the requirements.txt file.

We recommend using a virtual environment.

Installation

Via PIP

$ virtualenv -p python3 venv
$ source venv/bin/activate
$ pip install scoutsuite
$ scout --help

Demo

Installation via pip

Via Git

$ git clone https://github.com/nccgroup/ScoutSuite
$ cd ScoutSuite
$ virtualenv -p python3 venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ python scout.py --help

Computing resources

Scout Suite is a multi-threaded tool that fetches and stores your cloud account's configuration settings in memory during runtime. It is expected that the tool will run with no issues on any modern laptop or equivalent VM.

Note that running Scout Suite in a VM with limited computing resources such as an AWS t2.micro instance is not intended and may result in the process being killed.

Clone this wiki locally