← Back

Integration Guide

Configure your toolchain to use PkgRelay.

Overview

PkgRelay is a transparent proxy and cache for common package registries. Point your build tools at the relay endpoint and artifacts are mirrored on first request.

Quick Start

1. Obtain an X-Relay-Token from the dashboard.
2. Configure your package manager to use https://pkgrelay.net/<registry>.
3. Run your build as usual — artifacts are cached automatically.

npm

npm config set registry https://pkgrelay.net/npm/

PyPI

pip config set global.index-url https://pkgrelay.net/pypi/simple/

Docker

docker pull pkgrelay.net/docker/library/alpine:latest

Caching

Artifacts are cached for 30 days by default. Immutable versions are cached indefinitely.