Configuration

vey-keyless 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.

At a high level, vey-keyless is organized around a few main object types:

  • server accepts incoming keyless protocol requests

  • store defines where private keys are loaded from

  • backend defines how key operations are executed

Process-level settings such as runtime, worker, log, and stat control how the daemon runs and how it reports operational state.

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

pre_register

Map

no

Pre-registration configuration

server

Mix [1]

yes

Server configuration, see server

store

Mix [1]

yes

Private-key store configuration, see Store

backend

Mix [1]

yes

Backend configuration, see backend

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

Footnotes