Skip to main content

Installation

This guide covers the installation of paqet on all supported platforms.

Download from Releases

Download the pre-compiled binary for your client and server operating systems from the Releases page. Choose the appropriate binary for your platform:
  • Linux AMD64: paqet_linux_amd64
  • Linux ARM64: paqet_linux_arm64
  • macOS AMD64: paqet_darwin_amd64
  • macOS ARM64: paqet_darwin_arm64
  • Windows AMD64: paqet_windows_amd64.exe

Platform-Specific Prerequisites

paqet requires libpcap development libraries on both the client and server machines.

Linux Prerequisites

No prerequisites needed - binaries are statically linked and include all necessary dependencies.Simply download the binary and make it executable:
chmod +x ./paqet_linux_amd64
You will need root privileges to use raw sockets. Run paqet with sudo.

Running paqet

paqet requires root/administrator privileges to use raw sockets.
sudo ./paqet_linux_amd64 run -c config.yaml

Available Commands

paqet is a multi-command application. The primary command is run, which starts the proxy, but several utility commands are included to help with configuration and debugging. The general syntax is:
sudo ./paqet <command> [arguments]
CommandDescription
runStarts the paqet client or server proxy. This is the main operational command.
secretGenerates a new, cryptographically secure secret key.
pingSends a single test packet to the server to verify connectivity.
dumpA diagnostic tool similar to tcpdump that captures and decodes packets.
versionPrints the application’s version information.

Verifying Installation

To verify that paqet is installed correctly, run:
sudo ./paqet version
This should display the version information for paqet.

Next Steps

Quickstart

Get up and running with paqet in minutes

Configuration

Learn how to configure paqet for your needs

Build docs developers (and LLMs) love