Skip to content

Latest commit

 

History

History
164 lines (114 loc) · 3.51 KB

INSTALLING_WITH_PIPX.md

File metadata and controls

164 lines (114 loc) · 3.51 KB

Installing wlanpi-profiler using pipx

It is possible to install profiler outside of the WLAN Pi ecosystem on distributions such as Debian or Ubuntu using the pipx package manager. There are some tradeoffs, but the core profiler features will still work.

Assumptions:

  • profiler does not already exist on the host
  • you are comfortable running profiler from the terminal on the host

The base requirements to install and use profiler include:

  • Python 3.7+, pip, and pipx
  • root permissions on your OS
  • a WLAN adapter capable of monitor mode + packet injection (profiler assumes adapter name is wlan0 by default)

Tradeoffs of this installation method

  • manpage entry is not installed; man wlanpi-profiler does not work
  • config.ini is not installed; /etc/wlanpi-profiler/config.ini does not exist
  • systemd service unit is not installed; sudo service wlanpi-profiler status will not work

Installing the dependencies (Debian package manager)

These are the instructions for first time installs.

  1. Download updated package information from configured sources
sudo apt update
  1. Install Python3, pip, python-venv and tcpdump
sudo apt install python3 python3-pip python3-venv tcpdump
  1. Update pip, setuptools, and wheel to the latest versions
python3 -m pip install -U pip setuptools wheel
  1. Install Pipx from PyPI with pip

Note: it's important to use the -p argument to preserve the environment variables. The -p option prevents su from resetting $PATH.

sudo su -p
python3 -m pip install -U pipx
python3 -m pipx ensurepath
exit
  1. Install profiler from source
sudo su -p
pipx install git+https://github.com/WLAN-Pi/wlanpi-profiler.git@main#egg=profiler
exit

Ok, validate that it's installed!

sudo su -p
which pipx
which profiler
profiler --version

You should see something like this:

# which pipx
/usr/local/bin/pipx
# which profiler
/root/.local/bin/profiler
# profiler --verison
1.0.13

Running profiler

Usage:

$ sudo su -p
# profiler -h

Custom settings

$ sudo su -p
# profiler -i wlan1 -c 40 -s "My custom SSID"

Verbose/debug mode:

$ sudo su -p
# profiler --debug

Conflicting processes

Since you likely installed this on an OS that is not WLAN Pi, I recommend installing aircrack-ng and using airmon-ng to check and kill any processes that will take control of the WLAN NIC you're likely planning on using with profiler.

  1. Install aircrack-ng
$ sudo apt update
$ sudo apt install aircrack-ng
  1. Run airmon-ng
$ sudo airmon-ng check
$ sudo airmon-ng check kill
  1. Run profiler
$ sudo su -p
# profiler

Upgrading profiler

  1. Update pipx to the latest (optional)
sudo python3 -m pip install -U pipx
$ sudo su -p
# pipx upgrade profiler
profiler is already at latest version 1.0.13 location: /root/.local/pipx/venvs/profiler)

Uninstalling profiler

$ sudo su -p
# pipx uninstall profiler
uninstalled profiler! ✨ 🌟 ✨

Installing a specific version of profiler

You can specify the branch or tag like when installing via pipx. You can find the tags here.

Here is an example for how we might install the v1.0.13 tag:

$ sudo su -p
# pipx install git+https://github.com/WLAN-Pi/[email protected]#egg=profiler

Please let us know if there are any mistakes in these instructions. Thanks!