Install

Installing Leaker

Learn how to install and get started with Leaker

Quick Install

Go

go install -v github.com/vflame6/leaker@latest

Note: Leaker requires Go 1.24+ to install successfully.

Pre-built Binaries

Download the latest binary for your platform from the Releases page.

1. Download the archive for your OS and architecture
2. Extract the binary
3. Move it to a directory in your PATH

Build from Source

git clone https://github.com/vflame6/leaker.git
cd leaker
go build -o leaker main.go
mv leaker /usr/local/bin/
leaker --version

Docker

Build the Docker image:

docker build -t leaker .

Run with Docker:

docker run leaker email user@example.com

To use a local provider config with Docker:

docker run -v $HOME/.config/leaker:/home/app/.config/leaker leaker email user@example.com

Installation Notes

• Leaker requires Go 1.24 or later. Download it from go.dev.
• When installing via go install, ensure $HOME/go/bin is in your system PATH:

# Linux / macOS
echo 'export PATH=$PATH:$HOME/go/bin' >> $HOME/.bashrc
source $HOME/.bashrc

# Or for zsh
echo 'export PATH=$PATH:$HOME/go/bin' >> $HOME/.zshrc
source $HOME/.zshrc

• The installed binary will be located at $HOME/go/bin/leaker

Post-Install Configuration

Leaker works immediately after installation - sources that don't require API keys (ProxyNova, Hudson Rock free tier) are available out of the box.

However, most sources require API keys for full functionality. On first run, leaker generates a provider-config.yaml file at:

• Linux/macOS: $HOME/.config/leaker/provider-config.yaml
• Custom location: Set via LEAKER_PROVIDER_CONFIG environment variable or -p flag

See the Configuration page for details on setting up API keys.

Verify Installation

leaker --version

List available sources and check which ones have keys configured:

leaker -L

Sources marked with * require API keys to function.

Updating

To update to the latest version:

go install -v github.com/vflame6/leaker@latest

Or download the latest binary from the Releases page.