.. _configuration:

#############
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.

.. list-table::
   :header-rows: 1

   * - Key
     - Type
     - Reload
     - Description
   * - runtime
     - Map
     - no
     - Runtime configuration, see :doc:`runtime`
   * - worker
     - Map [#w]_
     - no
     - Starts unaided worker runtimes if present
   * - log
     - Map
     - no
     - Logging configuration, see :doc:`log/index`
   * - stat
     - Map
     - no
     - Metrics configuration, see :doc:`stat`
   * - controller
     - Seq
     - no
     - Controller configuration
   * - pre_register
     - Map
     - no
     - Pre-registration configuration
   * - server
     - Mix [#m]_
     - yes
     - Server configuration, see :doc:`server`
   * - store
     - Mix [#m]_
     - yes
     - Private-key store configuration, see :doc:`stores/index`
   * - backend
     - Mix [#m]_
     - yes
     - Backend configuration, see :doc:`backend`

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

.. rubric:: Footnotes

.. [#m] See :external+values:ref:`hybrid map <conf_value_hybrid_map>` for the actual format.
.. [#w] See :external+values:ref:`unaided runtime config <conf_value_unaided_runtime_config>`.

.. toctree::
   :hidden:

   runtime
   log/index
   stat
   server
   stores/index
   backend
   values