Skip to content
GitLab
Menu
Why GitLab
Pricing
Contact Sales
Explore
Why GitLab
Pricing
Contact Sales
Explore
Sign in
Get free trial
Primary navigation
Search or go to…
Project
buildgrid
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Privacy statement
Keyboard shortcuts
?
What's new
6
Snippets
Groups
Projects
Show more breadcrumbs
BuildGrid
buildgrid
Commits
eba38225
Commit
eba38225
authored
6 years ago
by
Martin Blanchard
Browse files
Options
Downloads
Patches
Plain Diff
docs: Add reference to server configuration section
BuildGrid/buildgrid#147
parent
b55ce53c
No related branches found
No related tags found
1 merge request
!130
Authentication/Authorization configuration support
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/reference_server_config.rst
+36
-5
36 additions, 5 deletions
docs/source/reference_server_config.rst
with
36 additions
and
5 deletions
docs/source/reference_server_config.rst
+
36
−
5
View file @
eba38225
.. _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:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment