Installation

This page will guide you through the installation process for Iridium.

To check that you have the latest version of Iridium, you can run iridium --version in your terminal.

Docker

You can run Iridium using Docker with the following command:

docker run -d \
  -p 8080:8080 \
  -v ./iridium-data:/root/.iridium \
  --name iridium \
  ghcr.io/iridiumproxy/iridium:latest

Docker Compose

You can also use Docker Compose to set up Iridium. Create a docker-compose.yml file with the following content:

docker-compose.yml

services:
  iridium:
    image: ghcr.io/iridiumproxy/iridium:latest
    container_name: iridium
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - ./iridium-data:/root/.iridium

Prebuilt Binaries

You can download prebuilt binaries for various operating systems from the Iridium Releases page on GitHub.

macOS

If you’re using macOS, you can run the following command to install Iridium with Homebrew:

brew install iridiumproxy/iridium/iridium

Build from source

To build Iridium from source, you’ll need to have the following prerequisites installed on your machine:

• Go 1.25+
• Git

Once you have the prerequisites installed, you can clone the Iridium repository and build the project by running the following commands:

git clone https://github.com/IridiumProxy/iridium.git
cd iridium
go build -o iridium .