Quick Start

1. Start the proxy

proxelar

This starts Proxelar in forward proxy mode with the interactive TUI on 127.0.0.1:8080.

2. Install the CA certificate

To inspect HTTPS traffic, your system needs to trust Proxelar’s CA certificate. The easiest way:

1. Configure your browser or system proxy to 127.0.0.1:8080
2. Visit http://proxel.ar through the proxy
3. Follow the platform-specific installation instructions on the page

Alternatively, manually install ~/.proxelar/proxelar-ca.pem.

3. Browse through the proxy

Configure your system or browser proxy to 127.0.0.1:8080. All HTTP and HTTPS traffic now flows through Proxelar and appears in the TUI.

Use the keyboard to navigate:

4. Try a Lua script

Create a file called script.lua:

function on_request(request)
    request.headers["X-Proxied-By"] = "proxelar"
    return request
end

Run Proxelar with the script:

proxelar --script script.lua

Every request passing through the proxy now has the X-Proxied-By header injected.