Pavonis Documentation

Pavonis is a multi-purpose HTTP reverse proxy written in Go. A single YAML config file is all you need to run multiple proxy sites of different types simultaneously.

Navigation

📖 Guide

Learn the fundamentals and get up and running quickly.

• Getting Started — Installation, minimal config, and launching
• Core Concepts — Sites, modes, path prefixes, self_url explained

✨ Features

An overview of Pavonis's core capabilities.

• Feature Overview — Site modes, rate limiting, IP pool and more at a glance

📦 Site Modes

Detailed settings, parameters and examples for each mode.

• GitHub Asset Acceleration — gh_proxy mode
• Container Registry Proxy (Single) — container_registry_single mode
• Container Registry Proxy (Any) — container_registry_any mode
• General HTTP Reverse Proxy — http mode
• PyPI Mirror — pypi mode
• HuggingFace Download Proxy — hugging_face mode
• Speed Test — speed_test mode

⚙️ Config Reference

Complete documentation for every configuration field.

• Config Overview — Full config file example and top-level fields
• ServerConfig
• RequestConfig
• ResponseConfig
• ResourceLimitConfig
• SiteConfig
• ContainerRegistryAuthConfig
• DiagnosticsConfig