vey-proxy Documentation
vey-proxy is a modular async Rust proxy daemon that unifies HTTP(S) and
SOCKS4/5 forward proxying, HTTP and TLS reverse proxying through site groups,
SNI and TPROXY transparent proxying, and TCP/UDP/TLS stream proxying in a
single hot-reloadable service. It combines built-in security auditing (TLS/TLCP
interception, DPI, ICAP adaptation, stream detours, and decrypted-traffic
export), flexible egress routing, pluggable authentication, DNS control,
structured logs, and StatsD metrics.
This documentation is organized by operational concern so you can move quickly from high-level understanding to concrete configuration details:
Use the configuration reference to understand how to define servers, escapers, resolvers, auth backends, loggers, and shared value types.
Use the protocol reference to understand client-side headers, helper-service protocols, and deployment-related setup topics.
Use the metrics and log references when integrating monitoring, dashboards, alerting, or downstream log pipelines.
The sections below are the main entry points.
Documentation Map
What You Will Find
Configuration Reference
The configuration reference documents the static configuration model used by
vey-proxy. It covers the top-level runtime layout and the concrete
configuration types for:
servers that accept client traffic
escapers that decide how outbound traffic is forwarded
resolvers that control name resolution behavior
auth components that define users, groups, and auth sources
site groups that map Host / SNI names to reverse-proxy origins
logging, metrics, and shared value objects reused across the config tree
Protocol Details
The protocol section describes interfaces around vey-proxy rather than the
configuration syntax itself. This includes client-facing protocol extensions,
helper-service protocols used by external components, and setup guides for
deployment scenarios such as transparent proxying and packet capture.
Metrics Definition
The metrics section explains the exported counters, gauges, and tags used by
vey-proxy. It is the reference to use when building dashboards, tuning
StatsD ingestion, or interpreting per-server, per-escaper, and per-user
traffic statistics.
Log Format
The log section documents the structured log records emitted by different subsystems, including request task logs, escape logs, and resolver logs. Use this section when integrating with log collectors or when you need exact field definitions for analysis pipelines.