Configuration

vey-proxy uses YAML for configuration.

The main configuration file is specified with the -c command-line option. If a directory is set, the main configuration file is loaded automatically from it based on the executable binary name. Its top-level keys are listed below.

Multiple YAML documents in the same file are accepted and are merged as if they were one configuration file.

At a high level, vey-proxy is organized around a small set of reusable object families:

• server accepts inbound traffic and defines frontend behavior

• escaper controls how outbound traffic leaves the daemon

• resolver defines DNS resolution behavior

• user_group defines authentication, identity, and policy

• auditor adds inspection, interception, or adaptation logic

Static process-level settings such as runtime, worker, log, and stat live at the top level of the main configuration file alongside those reusable objects.

Key	Type	Reload	Description
runtime	Map	no	Runtime configuration, see Runtime
worker	Map [2]	no	Starts unaided worker runtimes if present
log	Map	no	Logging configuration, see Log
stat	Map	no	Metrics configuration, see Stat
controller	Seq	no	Controller configuration
resolver	Mix [1]	yes	Resolver configuration, see Resolver
escaper	Mix [1]	yes	Escaper configuration, see Escaper
user_group	Mix [1]	yes	User-group configuration, see Auth
auditor	Mix [1]	yes	Auditor configuration, see Auditor
server	Mix [1]	yes	Server configuration, see Server

Read the object-family sections listed in the hidden toctree below when you need the detailed keys and behavior for each component type.

Footnotes

[1] (1,2,3,4,5)

See hybrid map for the actual format.

[2]

See unaided runtime config.

The top-level key user is accepted as an alias of user_group.