Skip to content

Installation

percepo edited this page Aug 19, 2023 · 3 revisions

Multiple steps for installing something is too much!

Long term, we want to enable installing wenum through a simple pip install (see https://github.com/WebFuzzForge/wenum/issues/22).

Instructions

Until then, it's a few manual commands. A typical workflow for installing could be as follows:

First, it is recommended to create a virtualenv to avoid installing the project dependencies into the system packages:

If unsure, go for sth like '/opt/wenum_venv'

mkdir $PATH_TO_VENV_FOLDER_OF_CHOICE
python3 -m venv $PATH_TO_VENV_FOLDER_OF_CHOICE

Once created, only the source command is necessary to activate the venv in the future. Command for bash: source $PATH_TO_VENV_FOLDER_OF_CHOICE/bin/activate

Poetry probably won't be installed in the venv yet, therefore run: pip install poetry

Debian-based distros may need the apt-packages libssl-dev and libcurl4-openssl-dev

Afterwards, the submodule commands will initialize linkfinder as the submodule, and lastly the project with its dependencies installed by poetry:

git clone $LINK_TO_REPO
cd wenum/
git submodule update --init --remote
poetry install

Pulling changes ("Updating")

Since this repo contains linkfinder as a submodule, it is recommended to adjust the pulling command to include changes of it as well. Execute git pull --recurse-submodules to pull those changes, too.

To ensure being in the newest commit of submodules (here: linkfinder), execute git submodule update --remote

Plugins

To utilize the gau plugin, you will need to install it first (it needs to be in your path): https://github.com/lc/gau

Clone this wiki locally