Linux Binary

Preflight Check

If you'd like to verify your environment's compatibility, use the following script:

curl -sSL https://github.com/qpoint-io/preflight/releases/latest/download/preflight.sh | bash

Prerequisites

• A Linux host with supported kernel (5.10+) and architecture (x86_64 or arm64)

• For cloud-connected mode: Registration Token

  • A valid registration token from app.qpoint.io (Settings -> Installation)

• For local mode: Configuration File

  • Prepare your Qtap YAML config file

Get Tapping

Run the installer script:

curl -s https://get.qpoint.io/install | sudo sh

Move on to Running Qtap Binary.

Manual installation

If you would like to install Qtap manually, start by downloading the release archive:

For Linux x86_64 architecture:

curl -L https://downloads.qpoint.io/qpoint/qtap-v0.9.3-linux-amd64.tgz -o qtap.tgz

For Linux arm64 architecture:

curl -L https://downloads.qpoint.io/qpoint/qtap-v0.9.3-linux-arm64.tgz -o qtap.tgz

Then, extract the binary and move it to /usr/local/bin:

tar -xzf qtap.tgz && \
    sudo mv qtap-* /usr/local/bin/qtap && \
    sudo chmod +x /usr/local/bin/qtap

This will extract a binary named qtap and make it executable.

Running Qtap Binary

You can run the binary by issuing the following commands.

Cloud Connected Mode

To run Qtap in cloud-connected mode:

sudo qtap --registration-token=$TOKEN

Replace $TOKEN with your actual registration token from app.qpoint.io (Settings -> Installation).

Local YAML Mode

To run Qtap in local mode:

sudo qtap --config=/path/to/your/qpoint.yaml

Replace /path/to/your/qpoint.yaml with the actual path to your YAML configuration file.

Running Qtap as a Service

After downloading and verifying the Qtap binary, you'll likely want to run it as a systemd service.

Service Configuration

1. Create Environment File

First, create a secure environment file to store sensitive environment variables:

sudo mkdir -p /etc/qtap && \
    touch /etc/qtap/environment && \
    chmod 600 /etc/qtap/environment

Add your registration token to the environment file:

echo "REGISTRATION_TOKEN=your_registration_token_here" | sudo tee /etc/qtap/environment

2. Create Service File

Create a systemd service file:

sudo nano /etc/systemd/system/qtap.service

Add the following content:

[Unit]
Description=Qtap Traffic Analysis Service
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
User=root
EnvironmentFile=/etc/qtap/environment
ExecStart=/usr/local/bin/qtap
Restart=always
RestartSec=1

[Install]
WantedBy=multi-user.target

Managing the Service

1. Reload systemd to recognize the new service:

sudo systemctl daemon-reload

1. Start the service:

sudo systemctl start qtap

1. Enable the service to start on boot:

sudo systemctl enable qtap

1. Check the service status:

sudo systemctl status qtap

1. View service logs:

sudo journalctl -u qtap -f

Updating the Service

1. Stop the service:

sudo systemctl stop qtap

1. Replace the binary:

sudo mv new-qtap /usr/local/bin/qtap
sudo chmod +x /usr/local/bin/qtap

1. Restart the service:

sudo systemctl start qtap

1. Verify the update:

qtap --version
sudo systemctl status qtap