Config Overview

Pavonis uses a YAML config file specified via the --config flag.

Top-Level Fields

Field	Type	Required	Description
debug	bool	No	Enable debug logging. Default false
server	ServerConfig	No	Server listen address and trusted proxy config
request	RequestConfig	No	Outbound request config (proxy, IP pool, header modification)
response	ResponseConfig	No	Response config (max redirects, response header modification)
resource_limit	ResourceLimitConfig	No	Traffic and request rate limits
diagnostics	DiagnosticsConfig	No	Diagnostics service config
sites	[]SiteConfig	Yes	Site list; each entry configures one proxy site

Config is the top-level config struct.

Full Config Example

A complete config file covering multiple features (all domain names are anonymised):

debug: false

server:
  listen: 0.0.0.0:8009
  trusted_proxy_ips:
    - '127.0.0.1/24'
    - '10.0.0.0/8'
  trusted_proxy_headers:
    - 'CF-Connecting-IP'
    - 'X-Forwarded-For'
    - 'X-Real-IP'

request:
  ip_pool:
    enabled: true
    default_strategy: none
    subnets:
      - '2001:db8::/48'

resource_limit:
  traffic_avg_mibps: 100
  traffic_burst_mib: 50
  traffic_max_mibps: 200
  request_per_second: 100
  request_timeout: 30m

diagnostics:
  enabled: true
  listen: 127.0.0.1:6009

sites:
  # GitHub asset acceleration
  - id: ghproxy
    host: gh.example.com
    mode: gh_proxy
    settings:
      size_limit: 104857600

  # Docker Hub proxy
  - id: dockerhub
    host: docker.example.com
    mode: container_registry_single
    self_url: https://docker.example.com

  # GHCR proxy
  - id: ghcr
    host: ghcr.example.com
    mode: container_registry_single
    self_url: https://ghcr.example.com
    settings:
      upstream_v2_url: https://ghcr.io/v2
      upstream_auth_realm_url: https://ghcr.io/token

  # Universal registry mirror
  - id: mirror
    host: mirror.example.com
    mode: container_registry_any
    self_url: https://mirror.example.com

  # Minecraft auth aggregation proxy
  - id: mcauth
    host: mc.example.com
    mode: http
    settings:
      mappings:
        - path: '/auth'
          destination: https://authserver.mojang.com
        - path: '/account'
          destination: https://api.mojang.com
        - path: '/session'
          destination: https://sessionserver.mojang.com
        - path: '/services'
          destination: https://api.minecraftservices.com

  # PyPI mirror
  - id: pypi
    host: pypi.example.com
    mode: pypi

  # HuggingFace download proxy
  - id: huggingface
    host: hf.example.com
    mode: hugging_face
    self_url: https://hf.example.com

  # Speed test (shares host with PyPI, distinguished by path prefix)
  - host: pypi.example.com
    mode: speed_test
    path_prefix: /speedtest