Installation

Nvelox is a single static binary with no runtime dependencies. Choose your preferred method below.

Docker (Recommended)

Pull the official image from GitHub Container Registry. Supports amd64 and arm64.

Binary Download

Download pre-built binaries from GitHub Releases. Available for Linux, macOS, and Windows.

Build from Source

Requires Go 1.22+. Clone the repo and build with the standard toolchain.

Verify Installation

Run nvelox --version to confirm the binary works.

Docker pull

docker pull ghcr.io/nvelox/nvelox:latest

# Run with a config file
docker run -d \
  --name nvelox \
  -p 8080:8080 \
  -p 8443:8443 \
  -v ./nvelox.yaml:/etc/nvelox/nvelox.yaml \
  ghcr.io/nvelox/nvelox:latest

Binary download (Linux)

# Download latest release
curl -sL https://github.com/nvelox/nvelox/releases/latest/download/nvelox-linux-amd64 \
  -o /usr/local/bin/nvelox
chmod +x /usr/local/bin/nvelox

Build from source

git clone https://github.com/nvelox/nvelox.git
cd nvelox
go build -o /usr/local/bin/nvelox ./cmd/nvelox

Verify

nvelox --version
# nvelox version 1.0.0 (commit: abc123, built: 2025-01-15)