Installation

Prerequisites

• macOS or Linux (Windows not tested)

Quick Install (Recommended)

Run the install script to download and set up APXY automatically:

curl -fsSL https://apxy.dev/install.sh | bash

This installs the binary to ~/.apxy/bin/apxy and adds it to your PATH.

Manual Download

Or download manually from GitHub Releases :

chmod +x apxy-darwin-arm64
mv apxy-darwin-arm64 apxy
sudo mv apxy /usr/local/bin/

Verify installation

apxy version
# APXY v1.0.5

macOS note: The official release binaries are signed with an Apple Developer ID and notarized by Apple. They run without Gatekeeper warnings. If macOS blocks a binary, go to System Settings > Privacy & Security and click “Allow Anyway”, or run:

xattr -d com.apple.quarantine ./apxy

Linux certificate trust

On Linux, after generating the APXY CA certificate, you need to add it to the system trust store:

# Generate the CA certificate
apxy certs generate
 
# Copy to the system trust store (Debian/Ubuntu)
sudo cp ./certs/apxy-ca.crt /usr/local/share/ca-certificates/apxy-ca.crt
sudo update-ca-certificates
 
# For RHEL/CentOS/Fedora
sudo cp ./certs/apxy-ca.crt /etc/pki/ca-trust/source/anchors/apxy-ca.crt
sudo update-ca-trust

See Certificate Setup for more details.