Skip to content

Installation

Tek edited this page Dec 17, 2020 · 5 revisions

Here is how to install Harpoon on Ubuntu (it should be quite similar on debian-based systems).

Install pre-requiste

sudo apt-get install libxml2-dev libxslt-dev python3-dev geoipupdate

You will need to have MaxMind geoipupdate correctly configured : create an account on MaxMind website and get an API key. Then update the file /etc/GeoIP.conf:

# Replace YOUR_ACCOUNT_ID_HERE and YOUR_LICENSE_KEY_HERE with an active account
# ID and license key combination associated with your MaxMind account. These
# are available from https://www.maxmind.com/en/my_license_key.
AccountID ID
LicenseKey KEY

# Enter the edition IDs of the databases you would like to update.
# Multiple edition IDs are separated by spaces.
EditionIDs GeoLite2-Country GeoLite2-City GeoLite2-ASN

You can then run sudo geoipupdate to get the last GeoIP databases (they should be available in /usr/share/GeoIP/GeoLite2-City.mmdb and /usr/share/GeoIP/GeoLite2-ASN.mmdb)

Install Harpoon

It is recommended to use virtualenvs with python3 (Harpoon does not support python2). Then you can install harpoon with pip : pip install harpoon.

Alternately, you can install it directly from the source repository:

git clone https://github.com/Te-k/harpoon.git
cd harpoon
pip3 install .

You may want to install harpoontools to have additional commands using harpoon features, such as ipinfo, asninfo, dns etc. You can install it with pip : pip install harpoontools

Configuring Harpoon

Once installed, you need to download files needed for harpoon to work : harpoon update.

Then configure the API keys you have with harpoon config. You can check the plugins with a correct configuration with harpoon config -c

Updating Harpoon

If you installed harpoon from pypi, just do pip install -U harpoon.

If you installed harpoon from the git repository, go to the repository and use the following commands:

git pull origin master
pip install .

Troubleshooting

In some cases, you may have a missing package because of a bug during harpoon update (like ModuleNotFoundError: No module named "pygreynoisev1"), in that case, just install it from pypi with pip install NAME_OF_THE_MODULE.

You may also have issues if you are using a version of pip that is too old. You can upgrade pip with /usr/bin/python3 -m pip install --upgrade pip

Clone this wiki locally