Integration Guide

Configure your toolchain to use PkgRelay.

← Back

Overview

PkgRelay acts as a transparent proxy and cache for common package registries. Point your build tools at the relay endpoint and artifacts are automatically 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.

Example: npm

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

Example: Docker

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

Caching Behavior

Artifacts are cached for 30 days by default. Immutable versions (those with content hashes) are cached indefinitely. Cache can be invalidated per-tenant via the API.