Build a PiRogue

The hardware you need

In addition to a computer and an Internet connection, you will need, at least, a Raspberry Pi (+ its power supply), a SD-card and an ethernet cable.

Pick a Raspberry Pi

First, you need a Raspberry Pi. We support the following versions of Raspberry Pi:

  • Raspberry Pi 3 Model B
  • Raspberry Pi 3 Model B+
  • Raspberry Pi 4 Model B - 1GB
  • Raspberry Pi 4 Model B - 2GB
  • Raspberry Pi 4 Model B - 4GB
  • Raspberry Pi 4 Model B - 8GB

Important note: Suricata is disabled on devices having less then 1.5GB of RAM.

If you want to buy a Raspberry Pi, visit the rpilocator website to check for availability.

Pick a micro SD-card

Second, you need a SD-card to run your PiRogue. The SD-card has to be large enough to store the operating system and all the data generated by the PiRogue itself. By default, it stores 5 days of network traffic history.

You may choose:

  • a 32GB micro SD-card for regular use
  • a 64GB micro SD-card if you plan doing long runs, analyzing the traffic of multiple devices simultaneously

Pick an ethernet cable

In order to connect the PiRogue to the Internet, you should have an ethernet cable connecting your PiRogue to your network. A simple cat. 5 ethernet cable will do the job.

Optional stuff

Depending on your needs, you would want to add a hat to your PiRogue and protect everything with a case.

Build the PiRogue hat →

Build the PiRogue case →

Install PiRogue OS

Get PiRogue OS

PiRogue OS is periodically released. The OS is pre-configured so you just need to flash it on a micro SD-card. The image (the binary file to be flashed on the SD-card) is compressed. The file you have to download on your computer has a name following this schema PiRogue-OS-<year>-<month>-<day>.img.xz.

Download the latest version of PiRogue OS →

Set up your SD card

Advanced Linux users can use a combination of xz and dd commands to flash their SD-card.

We recommend to download Balena Etcher and install it on your computer. Run Balena Etcher as administrator and follow the steps illustrated by the screenshots below.

Download Balena Etcher →

The PiRogue
The PiRogue
The PiRogue
The PiRogue
The PiRogue
The PiRogue

Once the flashing is complete, eject the SD-card from your computer.

Set up the PiRogue

If you have the hat for your PiRogue, it is the good time for you to plug it in and put everything into the case. Insert your freshly flashed micro SD-card into the PiRogue, plug the ethernet cable to the PiRogue. Remember, this cable connects your PiRogue directly (or through network switch) to your ISP router.

If you plan to use the PiRogue in a production environment (office, lab), we suggest you follow the securing your Raspberry Pi guide.

First boot

First, check that the SD card is correctly inserted into the appropriate slot of your PiRogue and the ethernet cable is properly connected. Then, plug the power supply. Wait few minutes before trying to access your PiRogue.

Now, connect to your PiRogue using SSH.

ssh pi@pirogue.local

Type raspberry which is the default password and press Entrer.

Once connected, you have to finalize the installation of your PiRogue by running the following commands:

sudo apt update
sudo apt install pirogue-base -y
sudo apt dist-upgrade -y
sudo reboot

During the installation, when prompted, you will have to answer:

  • No to save iptables rules for IP v4
  • No to save iptables rules for IP v6
  • Yes to allow non-root users to capture network traffic
Allow non-root users to capture network traffic

Fire it up!

After few minutes, we will be able to connect a wi-fi device and use the PiRogue’s dashboard.

First, connect a wi-fi device such as your smartphone to the PiRogue’s wi-fi network PiRogue1 (default password: superlongkey). Next, open the PiRogue’s dashboard by going at http://<PiRogue IP address>:3000 with your Web browser or directly with this link:

Learn how to operate your PiRogue →

It will take around 4 minutes before network flows start appearing in the dashboard. At the first start of your PiRogue the dashboard will look empty or broken. Don’t worry, connect a device to the PiRogue’s WiFi network, wait 5 minutes and refresh the dashboard by pressing F5 key on your keyboard.

Open your dashboard →

Connect to your PiRogue with SSH →

Get the default configuration →