Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

Getting Iron-Proxy running in your environment takes less than a minute. The proxy is distributed as a single, statically compiled binary with no external dependencies.

Installation

Download the latest release for your operating system from the GitHub Releases page.

# Example for Linux x86_64
wget [https://github.com/thecoderbee/iron-proxy/releases/download/v4.0.3/iron-proxy-linux-amd64](https://github.com/thecoderbee/iron-proxy/releases/download/v4.0.3/iron-proxy-linux-amd64)
chmod +x iron-proxy-linux-amd64
sudo mv iron-proxy-linux-amd64 /usr/local/bin/iron-proxy

Initialization

Generate the default configuration file in your current directory:

iron-proxy init

This will create an iron-proxy.toml file containing a standard Layer 4 and Layer 7 cluster setup.

Running the Proxy

Validate your configuration syntax before starting:

iron-proxy check -c iron-proxy.toml

Start the proxy in the foreground (ideal for Docker/systemd):

iron-proxy run -c iron-proxy.toml

(Unix Only) Start the proxy as a detached background daemon:

iron-proxy start