Skip to content

Installation

J.Townsend edited this page Feb 20, 2022 · 33 revisions

Option 1 - Kali

The easiest way to use theHarvester is by simply using Kali Linux.
Make sure you are you using a recent version.
From there simply type: theHarvester -h and you are good to go!

Option 2 - Virtualenv

To use theHarvester with a virtualenv you do the following;

  • sudo apt install python3-virtualenv
  • virtualenv -p /usr/bin/python3 path/to/create/theHavester-venv
  • source path/to/theHarvester-venv/bin/activate

After doing the above you can be in theHarvester git clone and do the following pip3 install -r requirements.txt or if you are contributing to theHavester then you will want to install requirements/dev.txt

Option 3 - Docker

theHarvester can also be run with Docker.
First, build the docker image.

    $ ~ > git clone https://github.com/laramies/theHarvester 
    $ ~ > cd theHarvester
    $ ~ > docker build -t theharvester .
    $ ~ > docker run theharvester -h 

Option 4 - From Source

The third option is building from source, simply run these commands and you are all set!
Make sure you are using Python3.7+ and have pip>=20.3

    $ ~ > git clone https://github.com/laramies/theHarvester 
    $ ~ > cd theHarvester

    If developing do:
        $ ~ > python3 -m pip install -r requirements/dev.txt
    Else:
        $ ~ > python3 -m pip install -r requirements/base.txt

    $ ~ > python3 theHarvester.py -h  

API Keys

If you wish to use api keys make sure to edit api-keys.yaml

Modules that require API keys

The api-keys.yml file if installed using the setup.py or in kali are under /etc/theHarvester else it is in the root directory if you have git cloned.

  • binaryedge
  • bing
  • censys
  • FullHunt
  • github
  • hunter
  • intelx
  • pentestTools - paid
  • projectDiscovery
  • rocketreach
  • securityTrails
  • shodan
  • spyse
  • zoomeye

Clone this wiki locally