Skip to content
Snippets Groups Projects
Commit eba38225 authored by Martin Blanchard's avatar Martin Blanchard
Browse files

docs: Add reference to server configuration section

parent b55ce53c
No related branches found
No related tags found
1 merge request!130Authentication/Authorization configuration support
.. _parser:
Server configuration reference
==============================
.. _server-configuration:
BuildGrid's server configuration. To be used with::
Server configuration
====================
bgd server start server.conf
BuildGrid's server YAML configuration format details.
.. hint::
In order to spin-up a server instance using a given ``server.conf``
configuration file, run:
.. code-block:: sh
bgd server start server.conf
Please refer to the :ref:`CLI reference section <invoking-bgd-server>` for
command line interface details.
.. _server-config-reference:
Reference configuration
-----------------------
Below is an example of the full configuration reference:
.. literalinclude:: ../../buildgrid/_app/settings/reference.yml
:language: yaml
.. _server-config-parser:
Parser API
----------
The tagged YAML nodes in the :ref:`reference above <server-config-reference>`
are handled by the YAML parser using the following set of objects:
.. automodule:: buildgrid._app.settings.parser
:members:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment