For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

Installation

There are two ways to get maxmind-api-proxy running: build it from source or download a pre-built binary.


Option 1 — Build from source

Prerequisites

Steps

# Clone the repository
git clone https://github.com/k9io/maxmind-api-proxy.git
cd maxmind-api-proxy

# Download dependencies
go mod tidy

# Build the binary
go build -o maxmind-api-proxy

The resulting maxmind-api-proxy binary is statically linked with CGO_ENABLED=0 and has no runtime dependencies.

Building for a different platform

The build script in scripts/build-all cross-compiles for every platform Go supports. To build for a specific target manually:

Common GOOS/GOARCH combinations:

OS

Architecture

GOOS

GOARCH

Linux

64-bit Intel/AMD

linux

amd64

Linux

ARM 64-bit

linux

arm64

macOS

Apple Silicon

darwin

arm64

macOS

Intel

darwin

amd64

Windows

64-bit

windows

amd64

FreeBSD

64-bit

freebsd

amd64


Option 2 — Pre-built binaries

Pre-compiled binaries for Linux, macOS, Windows, FreeBSD, NetBSD, Solaris, and multiple CPU architectures are published at:

https://github.com/k9io/k9-binaries/tree/main/maxmind-api-proxy

Each binary is distributed as a .gz archive alongside a sha256 checksum file. Always verify the checksum before running a downloaded binary.


Next step

Once you have the binary, configure the proxy before running it.

Last updated