Documentation Index
Fetch the complete documentation index at: https://mintlify.com/hanselime/paqet/llms.txt
Use this file to discover all available pages before exploring further.
The paqet client acts as a SOCKS5 proxy server on your local machine, accepting connections from applications and forwarding them through raw TCP packets to the paqet server.
Find Your Network Details
Before configuring the client, you need to gather network information for your local machine.Find Interface and Local IP:Look for your primary network card (e.g., eth0, ens3). The IP address is listed under inet.Find Gateway MAC Address:# First, find your gateway's IP
ip r | grep default
# Then, find its MAC address (replace with your gateway IP)
arp -n 192.168.1.1
Find Interface and Local IP:Look for your primary interface (e.g., en0). The IP is listed under inet.Find Gateway MAC Address:# First, find your gateway's IP
netstat -rn | grep default
# Then, find its MAC address (replace with your gateway IP)
arp -n 192.168.1.1
Find Interface and Local IP:Note your active network adapter’s IP Address and Gateway IP Address.Find Interface GUID:Windows requires the Npcap device GUID. Run in PowerShell:Get-NetAdapter | Select-Object Name, InterfaceGuid
\Device\NPF_{YOUR-GUID-HERE}
Create Client Configuration File
Create a file named config.yaml in the same directory as your paqet binary:# Role must be explicitly set
role: "client"
# Logging configuration
log:
level: "info" # none, debug, info, warn, error, fatal
# SOCKS5 proxy configuration (client mode)
socks5:
- listen: "127.0.0.1:1080" # SOCKS5 proxy listen address
# Port forwarding configuration (can be used alongside SOCKS5)
# forward:
# - listen: "127.0.0.1:8080" # Local port to listen on
# target: "127.0.0.1:80" # Target to forward to (via server)
# protocol: "tcp" # Protocol (tcp/udp)
# Network interface settings
network:
interface: "en0" # CHANGE ME: Network interface (en0, eth0, wlan0, etc.)
# guid: "\\Device\\NPF_{...}" # Windows only (Npcap).
ipv4:
addr: "192.168.1.100:0" # CHANGE ME: Local IP (use port 0 for random port)
router_mac: "aa:bb:cc:dd:ee:ff" # CHANGE ME: Gateway/router MAC address
# Server connection settings
server:
addr: "10.0.0.100:9999" # CHANGE ME: paqet server address and port
# Transport protocol configuration
transport:
protocol: "kcp" # Transport protocol (currently only "kcp" supported)
kcp:
block: "aes" # Encryption algorithm
key: "your-secret-key-here" # CHANGE ME: Secret key (must match server)
Configure Network Interface
Update the network section with your network details from Step 1:For Linux/macOS:network:
interface: "en0" # Your network interface name
ipv4:
addr: "192.168.1.100:0" # Your local IP with port 0
router_mac: "aa:bb:cc:dd:ee:ff" # Your gateway MAC address
network:
interface: "Ethernet" # Your adapter name
guid: "\\Device\\NPF_{12345678-1234-1234-1234-123456789ABC}"
ipv4:
addr: "192.168.1.100:0" # Your local IP with port 0
router_mac: "aa:bb:cc:dd:ee:ff" # Your gateway MAC address
Always use port 0 in the client’s network.ipv4.addr setting. This enables automatic port assignment and prevents port conflicts.
Configure Server Address
Set the server.addr to your paqet server’s public IP address and port:server:
addr: "10.0.0.100:9999" # Your server's IP and port
listen.addr setting. Set Encryption Key
Configure the encryption key that matches your server:transport:
kcp:
block: "aes"
key: "your-secret-key-here" # Must match server exactly
Generate a secure key using: ./paqet secret
Run the Client
Make the binary executable and run with root privileges:# Make executable
chmod +x ./paqet_linux_amd64
# Run the client
sudo ./paqet_linux_amd64 run -c config.yaml
# Make executable
chmod +x ./paqet_darwin_arm64
# Run the client
sudo ./paqet_darwin_arm64 run -c config.yaml
# Run as Administrator in PowerShell
.\paqet_windows_amd64.exe run -c config.yaml
Root/Administrator privileges are required to use raw sockets.
Test the Connection
Once the client is running, test the SOCKS5 proxy:curl -v https://httpbin.org/ip --proxy socks5h://127.0.0.1:1080
Example Configuration
Here’s a complete working example for a macOS client:
role: "client"
log:
level: "info"
socks5:
- listen: "127.0.0.1:1080"
network:
interface: "en0"
ipv4:
addr: "192.168.1.100:0"
router_mac: "a0:b1:c2:d3:e4:f5"
server:
addr: "203.0.113.50:9999"
transport:
protocol: "kcp"
kcp:
block: "aes"
key: "my-secret-encryption-key"
Next Steps