Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 10:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixes, mainly revamp config specification and describe compat image

Browse Source
This commit is contained in:
Lucy Cifferello
2022-02-14 14:12:08 -07:00
parent eb415ba0e9
commit a9962d6171
10 changed files with 349 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
site/source/service-packaging/build-package-example/resources.rst
View File

@@ -16,11 +16,6 @@ When you have built and tested your project for EmbassyOS, please send Start9 a
If you are deploying to an alternative marketplace, please shout it out in our community channels!
Additional Options
------------------
Properties - TODO
References
----------

4
site/source/service-packaging/getting-started/environment-setup.rst
View File

@@ -6,7 +6,7 @@ Packaging Environment Setup
To get started packaging a service for EmbassyOS, some basic knowledge of software development is required. Don't worry if you are inexperienced, we will provide enough context to get you started, and you can always reach out with questions.
If you are already an experienced developer, :ref:`jump ahead <quick-start>`.
If you are already an experienced developer, :ref:`jump ahead <environment-quick-start>`.
The only system requirements are `Docker <https://docs.docker.com/get-docker>`_ and `Cargo <https://doc.rust-lang.org/cargo/>`_ (Rust package manager).
@@ -86,7 +86,7 @@ While not strictly necessary, having a running instance of EmbassyOS is recommen
You can acquire EmbassyOS by :ref:`purchasing <purchasing>` or following the :ref:`DIY guide <diy>`.
.. _quick-start:
.. _environment-quick-start:
Quick Start Environment Setup
-----------------------------

2
site/source/service-packaging/getting-started/quick-start.rst
View File

@@ -1,4 +1,4 @@
.. _quick-start:
.. _packaging-quick-start:
=====================
Packaging Quick Start

2
site/source/service-packaging/index.rst
View File

@@ -54,7 +54,7 @@ Service Packaging Overview
:class: large-4
:anchor: View
Discover details about Start9's Software Development Kit
Discover details about the Start9 Software Development Kit
.. topic-box::
:title: Full Specification

21
site/source/service-packaging/specification/compat/index.rst Normal file
View File

@@ -0,0 +1,21 @@
.. _compat:
============
Compat Image
============
With the release of EmbassyOS v0.3.0, system utility Docker images are preloaded for service packager convenience.
The ``Compat`` image is a backwards compatible Docker image that hosts EmbassyOS features used in the v0.2.x series. It was created as a convenience for service packagers to help migrate their service configurations from 0.2.x to 0.3.0.
It exposes functionality to make use of:
- ``ConfigRules`` language
- Duplicity backups
.. This is for the side navigation display
.. toctree::
:hidden:
rules

111
site/source/service-packaging/specification/compat/rules.rst Normal file
View File

@@ -0,0 +1,111 @@
.. _config_rules:
============
Config Rules
============
This file defines the configuration rules, or the rule-set that defines dependencies between config variables. In practice, config rules are for auto-configuring self dependencies. Self dependencies are internal dependencies of a service, such as if the setting of one config variable informs the option of another setting. These "dependencies" are configured as rules.
A rule is a boolean expression that we demand to be true. It is not true if the expression fails the rule parser. Set of predicates. xt
They follow the `Backus–Naur <https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form>`_ meta-syntax for writing rules.
Rules are composed of two main concepts:
* Variables - accessor into a configuration
* Terms - either a variable or type literal (ie. a boolean term is a boolean variable, a boolean expression, or a comparison operation between numbers or strings)
Variables can be booleans, numbers, or strings, and have a different syntax depending on the type. These type annotations check your config rules against your config spec and throw an error if invalid.
- ``?`` - Casts to boolean value. If the value is not a boolean, this notes whether or not the value is null.
- ``#`` - Treat the value as a number. If it is not a number, the value will be parsed as NaN. String numbers are not currently supported.
- ``'`` - Cast the value into a string. Applies to any value except for an object or a list.
- ``!`` - Equals not.
.. note::
Config rules are processed in order.
If application does not satisfy a rule, a set of suggestions should be provided. These suggestions are in the form of the operation to preform:
- ``Set`` - set the value
- ``Push`` - add to the value (such as to a list)
- ``Delete`` - delete the value
.. code:: typescript
enum SuggestionVariant = Set | Delete | Push
interface Set {
var: String, // fully qualified path without typecast
// one of the following three variants are required
to: Option<String> // a string expression, use when tying another config value
to-value: Option<String>
to-entropy: Option<{
charset: String (eg. 'a-z,A-Z,0-9')
len: Number
}>
}
interface Delete {
src: String, // path to key - removes if in a list
}
interface Push {
to: String,
value: String, // string literal of value to be set
}
SET Examples
------------
.. code:: yaml
- SET:
# the key in config you want to set
var: 'users.[first(item => ''item.name = "c-lightning")].password'
# the value in config that you will set
to-entropy:
charset: "a-z,A-Z,0-9"
len: 22
- SET:
var: 'users.[first(item => ''item.name = "c-lightning")].fetch-blocks'
to-value: true
PUSH Examples
-------------
.. code:: yaml
- PUSH:
to: "users"
value:
name: c-lightning
allowed-calls: []
- PUSH:
to: 'users.[first(item => ''item.name = "c-lightning")].allowed-calls'
value: "getnetworkinfo"
Full example from `c-lightning manifest <https://github.com/Start9Labs/c-lightning-wrapper/blob/master/manifest.yaml>`_:
.. code:: yaml
config:
- rule: '''users.*.name = "c-lightning"'
description: 'Must have an RPC user named "c-lightning"'
suggestions:
- PUSH:
to: "users"
value:
name: c-lightning
allowed-calls: []
- SET:
var: 'users.[first(item => ''item.name = "c-lightning")].password'
to-entropy:
charset: "a-z,A-Z,0-9"
len: 22

308
site/source/service-packaging/specification/config.rst → site/source/service-packaging/specification/config-spec.rst
View File

@@ -1,84 +1,77 @@
.. _configuration:
.. _config_spec:
=============
Configuration
=============
===========
Config Spec
===========
Introduction
============
Most self-hosted applications require the user to tell the app how to behave using a config file in a specific format, environment variables, command-line arguments, or some combination of these inputs. One of the coolest features of EmbassyOS is that, when packaged correctly, the app's configuration will be available to the user as a slick GUI that always produces a valid configuration no matter how little experience or skill the user has.
Most self-hosted applications require the user to tell the application how to behave using a config file in a specific format, environment variables, command-line arguments, or some combination of these inputs. One of the coolest features of EmbassyOS is that the services' configuration will be available to the user as a slick GUI that always produces a valid configuration no matter how little experience or skill the user has.
With EmbassyOS, this means a service wrappers' configuration requires a particular format and rule structure to ensure it integrates smoothly with the user interface. This format enables clean handling of improper values and dependency management.
With EmbassyOS, this means a services' configuration requires a file to define the particular format to ensure it integrates smoothly with the user interface. This format enables clean handling of improper values and dependency management.
The outcome of this step is two files:
This file defines the *structure* of the service's native config and should be curated according to the ``ConfigSpec`` type, which is a detailed mapping of the configuration options with acceptable values, defined patterns, and defaults.
:ref:`config_spec.yaml <config_spec>`
For example, if the user chooses config option A, then config option B must be between 5 and 10. This enables a simple GUI configuration experience, complete with validations and protections, for users. They do not have to worry about the consequences of a wrong value or manually editing a config file.
:ref:`config_rules.yaml <config_rules>`
Purpose
=======
These files contain a detailed mapping of configuration options with acceptable values, defaults, and relational rule-sets.
The ``ConfigSpec`` exists primarily an input specification and secondarily for input validation.
For example, if the user chooses config option A, then config option B must be between 5 and 10. This enables a simple GUI configuration experience, complete with validations and protections, for users. They do not have to worry about the consequences of a wrong value in a ``.conf`` file.
.. _config_spec:
Config Spec
===========
.. figure:: /_static/images/services/service5.png
:width: 80%
:alt: Synapse Config
This file defines the structure of configuration options your service depends on to run. It additionally can include configuration options that users might want to enable for more advanced or customized usage. Ultimately, these values influence the UI elements for a user to interact with. Specifically, they evaluate to the options available when managing a service, such as:
The file containing the ``ConfigSpec`` defines the structure of configuration options your service depends on to run. It additionally can include configuration options that users might want to enable for more advanced or customized usage. Ultimately, these values influence the UI elements for a user to interact with. Specifically, they evaluate to the options available when managing a service, such as:
- Prior to service installation when the user needs to be made aware of any necessary dependency configurations
- When the user installs a service and the service is in the "Needs Config" state
- Whenever a user edits a service config
- When config pointers get updated
The neat part about this file is that each ValueSpec type gets translated into a specific front end component. For instance, boolean values display as a toggle button, such as in the Synapse exmple of ``Enable Registration``.
The neat part about this file is that each ``ValueSpec`` type gets translated into a specific front end component. For instance, boolean values display as a toggle button, such as in the Synapse example of ``Enable Registration``.
.. figure:: /_static/images/services/synapseconfig.png
:width: 80%
:alt: Example boolean toggle
Another advantage is the ability to define default values. These values automatically get populated if the user selects the ``Default`` option when setting up a service in ``Needs Config`` state. This is super convenient for users who want to get up and running quickly.
Another advantage is the ability to define default values. These values automatically get populated if the user selects the ``Default`` option when setting up a service in ``Needs Config`` state. This is incredibly convenient for users who want to get up and running quickly.
Types
-----
Implementation
==============
ConfigSpec Type:
The following section contains implementation specifications for the structure of the file containing the ``ConfigSpec``. This config specification if of the type:
.. code::
.. code-block::
:caption: ConfigSpec
key: ValueSpec
ValueSpec Type: Boolean | Enum | List | Number | Object | String | Union | Pointer (see below for details)
ValueSpec Type: Boolean | Enum | List | Number | Object | String | Union | Pointer
Implementation Guide
--------------------
The following section contains implementation specifications for the ``config_spec.yaml`` file.
- All keys are ``kebab-case`` strings, which correspond to the service (app) id
- All keys are ``kebab-case`` strings, which correspond to the package id
- All values are one the following specs (ie. ``ValueSpec`` type):
:ref:`boolean <boolean>`
- :ref:`boolean <boolean>`
:ref:`enum <enum>`
- :ref:`enum <enum>`
:ref:`list <list>`
- :ref:`list <list>`
:ref:`number <number>`
- :ref:`number <number>`
:ref:`object <object>`
- :ref:`object <object>`
:ref:`string <string>`
- :ref:`string <string>`
:ref:`union <union>`
- :ref:`union <union>`
:ref:`pointer <pointer>`
- :ref:`pointer <pointer>`
- In the examples for each value spec type below, ``Option`` means the key is optional. Otherwise, the key is required.
- Descriptions are optional, but recommended
@@ -86,24 +79,29 @@ The following section contains implementation specifications for the ``config_sp
- Find a complete example :ref:`here <example_config_spec>`
- Change warning text displays when the value is altered
Specs
=====
These are the possible value types with examples for each key of the config specification.
.. _boolean:
Boolean
.......
-------
Config value specification denoted as a boolean value. A default value is required.
``ValueSpec`` Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: boolean
name: String
description: Option<String>
change-warning: Option<String>
warning: Option<String>
default: Boolean
Example:
Example
^^^^^^^^
.. code:: yaml
@@ -116,21 +114,24 @@ Example:
.. _enum:
Enum
....
----
Config value specification denoted as an enum value. Enums values must be a unique set. If no default is provided, ``null`` will be the assumed value.
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: enum
name: String
description: Option<String>
change-warning: Option<String>
warning: Option<String>
default: Option<Enum>
values: Set<String>
Example
^^^^^^^
.. code:: yaml
theme-mode:
@@ -147,7 +148,7 @@ ValueSpec Type:
.. _list:
List
....
----
The list type describes an array of values. The values must consist of the same subtype, which can be any of the ValueSpec types available in the EmbassyOS config specification.
Lists of any type do not contain the default for each item in list. The list *itself* can have a default. If no default is provided, ``null`` will be the assumed value.
@@ -166,19 +167,19 @@ eg:
[0,*) - all numbers to infinity including 0
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: list
name: String
description: Option<String>
subtype: enum || number || object || string || union
subtype: Enum<enum | number | object | string | union>
range: NumRange<unsigned integer>
spec: ValueSpec
default: ValueSpec
Example:
^^^^^^^^
.. code:: yaml
@@ -198,13 +199,12 @@ Example:
.. _number:
Number
......
------
A number value within an optionally defined range. Nullable field is required. If ``nullable`` is true, the default is assumed to be ``null`` if it is not provided.
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: number
name: String
@@ -216,7 +216,8 @@ ValueSpec Type:
integral: Boolean
units: Option<String>
Example:
Example
^^^^^^^
.. code:: yaml
@@ -232,31 +233,26 @@ Example:
.. _object:
Object Type
...........
-----------
A nested representation of a ConfigSpec. The object type takes the same structure under the ``spec`` key as a ConfigSpec: a key indicates the field name, and the value denotes the ValueSpec type for that field.
A nested representation of a ``ConfigSpec``. The object type takes the same structure under the ``spec`` key as a ``ConfigSpec``: a key indicates the field name, and the value denotes the ``ValueSpec`` type for that field.
There is no default option for the object type. Rather, the option ``null-by-default`` should be used to indicate the default as ``null``. If null by default is true, nullable must be true. If null by default is false, nullable could be either.
``unique-by`` indicates whether duplicates can be permitted in the list.
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: object
name: String
description: Option<String>
change-warning: Option<String>
nullable: Boolean
null-by-default: Boolean
warning: Option<String>
display-as: Option<String>
# indicates whether duplicates can be permitted
unique-by: UniqueBy
spec: ConfigSpec
type UniqueBy = null | string | { any: UniqueBy[] } | { all: UniqueBy[] }
Example:
Example
^^^^^^^
.. code:: yaml
@@ -300,35 +296,36 @@ Example:
.. _string:
String
......
------
There are various options for string values. They can optionally be marked as copyable or masked, such as for passwords, which will reflect the UI element display. A pattern, expressed in regex, can be denoted. If it exists, this field requires both the pattern type (ie. Regex) and pattern description (ie. an explanation of the pattern requirements).
If the default type is ``Entropy``, the charset can optionally specify an inclusive ranged character set (ie. "a-f,0-9").
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: string
name: String
description: Option<String>
change-warning: Option<String>
copyable: Option<boolean>
warning: Option<String>
masked: Option<boolean>
copyable: Option<boolean>
# Placeholder text in UI input box
placeholder: Option<String>
nullable: Boolean
default: String | Entropy
pattern: Option<Regex>
pattern-description: Option<String>
Entropy Type:
.. code::
.. code-block::
:caption: Entropy Type
charset: Option<String>
len: integer
Examples:
Examples
^^^^^^^^
.. code::
@@ -338,7 +335,7 @@ Examples:
description: Color value for the Lightning Network
nullable: false
pattern: "[0-9a-fA-F]{6}"
patternDescription: |
pattern-description: |
Must be a valid 6 digit hexadecimal RGB value. The first two digits are red, middle two are green and final two are
blue
default:
@@ -359,19 +356,18 @@ Examples:
.. _pointer:
Pointer
.......
--------
The pointer type *points* to a config value on another service installed on EmbassyOS (ie. app subtype) or to the EmbassyOS system (ie. system subtype). When pointing to another service, the ``index`` field indicates the path to the desired config variable.
The pointer type *points* to a config value on another service installed on EmbassyOS (ie. package subtype) or to the EmbassyOS system (ie. system subtype). When pointing to another service, the ``index`` field indicates the path to the desired config variable.
ValueSpec Type:
.. code::
.. code-block::
:caption: ValueSpec Type
type: pointer
name: String
description: Option<String>
change-warning: Option<String>
subtype: app | system
warning: Option<String>
subtype: Enum< package | system>
package-id: String (*always* kebab case)
target: AppPointerSpecVariants | SystemPointerSpecVariants
index: Option<String> (dependent on target being AppPointerSpecVariants)
@@ -379,7 +375,8 @@ ValueSpec Type:
AppPointerSpecVariants = TorAddress | TorKey | Config
SystemPointerSpecVariants = HostIp
Example:
Example
^^^^^^^
.. code::
@@ -387,7 +384,7 @@ Example:
type: pointer
name: RPC Username
description: The username for the RPC user for Bitcoin Core
subtype: app
subtype: package
package-id: bitcoind
target: config
index: "rpc.username"
@@ -395,7 +392,7 @@ Example:
.. _union:
Union
.....
-----
This type describes a necessary dependency. Multiple variants can be expressed to enable the user the option to connect to another service (internal dependency) or outside source (external dependency).
@@ -405,9 +402,8 @@ Default is required and corresponds to one of the variants.
``Tag`` is the key that will be rendered on the UI element.
ValueSpec Type;
.. code::
.. code-block::
:caption: ValueSpec Type
type: union
name: String
@@ -419,9 +415,8 @@ ValueSpec Type;
display-as: Option<String>
unique-by: any | all | exactly | notUnique
Tag Type:
.. code::
.. code-block::
:caption: Tag Type
id: String
name: String
@@ -430,7 +425,8 @@ Tag Type:
.. _example_config_spec:
Example:
Example
^^^^^^^
.. code:: yaml
@@ -492,117 +488,3 @@ Example:
nullable: false
pattern: 'btcstandup://[^:]*:[^@]*@[a-zA-Z0-9.-]+:[0-9]+(/(\?(label=.+)?)?)?'
patternDescription: Must be a valid Quick Connect URL. For help, check out https://github.com/BlockchainCommons/Gordian/blob/master/Docs/Quick-Connect-API.md
.. _config_rules:
Config Rules
============
This file defines the configuration rules, or the rule-set that defines dependencies between config variables. In practice, config rules are for auto-configuring self dependencies. Self dependencies are internal dependencies of a service, such as if the setting of one config variable informs the option of another setting. These "dependencies" are configured as rules.
A rule is a boolean expression that we demand to be true. It is not true if the expression fails the rule parser.
They follow the `Backus–Naur <https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form>`_ meta-syntax for writing rules.
Rules are composed of two main concepts:
* Variables - accessor into a configuration
* Terms - either a variable or type literal (ie. a boolean term is a boolean variable, a boolean expression, or a comparison operation between numbers or strings)
Variables can be booleans, numbers, or strings, and have a different syntax depending on the type. These type annotations check your config rules against your config spec and throw an error if invalid.
- ``?`` - Casts to boolean value. If the value is not a boolean, this notes whether or not the value is null.
- ``#`` - Treat the value as a number. If it is not a number, the value will be parsed as NaN. String numbers are not currently supported.
- ``'`` - Cast the value into a string. Applies to any value except for an object or a list.
- ``!`` - Equals not.
.. note::
Config rules are processed in order.
If application does not satisfy a rule, a set of suggestions should be provided. These suggestions are in the form of the operation to preform:
- ``Set`` - set the value
- ``Push`` - add to the value (such as to a list)
- ``Delete`` - delete the value
.. code:: typescript
enum SuggestionVariant = Set | Delete | Push
interface Set {
var: String, // fully qualified path without typecast
// one of the following three variants are required
to: Option<String> // a string expression, use when tying another config value
to-value: Option<String>
to-entropy: Option<{
charset: String (eg. 'a-z,A-Z,0-9')
len: Number
}>
}
interface Delete {
src: String, // path to key - removes if in a list
}
interface Push {
to: String,
value: String, // string literal of value to be set
}
Set Examples:
.. code:: yaml
- SET:
# the key in config you want to set
var: 'users.[first(item => ''item.name = "c-lightning")].password'
# the value in config that you will set
to-entropy:
charset: "a-z,A-Z,0-9"
len: 22
- SET:
var: 'users.[first(item => ''item.name = "c-lightning")].fetch-blocks'
to-value: true
Push Examples:
.. code:: yaml
- PUSH:
to: "users"
value:
name: c-lightning
allowed-calls: []
- PUSH:
to: 'users.[first(item => ''item.name = "c-lightning")].allowed-calls'
value: "getnetworkinfo"
Full example from `c-lightning manifest <https://github.com/Start9Labs/c-lightning-wrapper/blob/master/manifest.yaml>`_:
.. code:: yaml
config:
- rule: '''users.*.name = "c-lightning"'
description: 'Must have an RPC user named "c-lightning"'
suggestions:
- PUSH:
to: "users"
value:
name: c-lightning
allowed-calls: []
- SET:
var: 'users.[first(item => ''item.name = "c-lightning")].password'
to-entropy:
charset: "a-z,A-Z,0-9"
len: 22
.. role:: raw-html(raw)
:format: html
:raw-html:`<br />`

99
site/source/service-packaging/specification/index.rst
View File

@@ -1,17 +1,107 @@
.. _service-packaging-spec:
===============================
Service Packaging Specification
===============================
=============
Specification
=============
The following guides provide an in depth overview of the full capabilities available for packaging a service.
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Docker
:link: docker
:class: large-4
:anchor: View
Learn how to setup the main Docker image for your service.
.. topic-box::
:title: Manifest
:link: manifest
:class: large-4
:anchor: Begin
Understand the function of a Manifest file and its type.
.. topic-box::
:title: Config Spec
:link: config-spec
:class: large-4
:anchor: Begin
Learn the purpose and utility of a config specification.
.. topic-box::
:title: Properties
:link: properties
:class: large-4
:anchor: View
Understand the purpose and requirements of service properties.
.. topic-box::
:title: Dependencies
:link: dependencies
:class: large-4
:anchor: View
Learn how to configure dependency options.
.. topic-box::
:title: Backups
:link: advanced
:class: large-4
:anchor: View
Learn how to configure backup options.
.. topic-box::
:title: Instructions
:link: instructions
:class: large-4
:anchor: View
Understand how an instructions file is relevant to a service.
.. topic-box::
:title: Package
:link: package
:class: large-4
:anchor: View
Learn how to package service components into a single file format.
.. topic-box::
:title: Wrapper
:link: wrapper
:class: large-4
:anchor: View
Understand the purpose of a wrapper repository.
.. topic-box::
:title: Submission
:link: submission
:class: large-4
:anchor: View
Learn about how to submit a package for review to a marketplace.
.. raw:: html
</div></div>
.. toctree::
:hidden:
docker
manifest
config
config-spec
properties
dependencies
backups
@@ -20,3 +110,4 @@ The following guides provide an in depth overview of the full capabilities avail
wrapper
makefile
submission
compat/index

23
site/source/service-packaging/specification/properties.rst
View File

@@ -6,13 +6,34 @@ Properties
The output of this step is a file titled ``stats.yaml``. This file contains a mapping of the values that will be displayed in the ``Properties`` section in a service's menu.
Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime.
.. figure:: /_static/images/services/service-properties.png
:width: 80%
:alt: Service Properties
Service Properties
Due to the fact that config variables are only available when the service is running, this file can only be populated at runtime. In services Start9 has wrapped or created, we typically handle this in ``configurator/src/main.rs``. This file is essentially a script that acquires the necessary values at runtime from config (eg. ``/root/.lnd/start9/config.yaml``), and dynamically populating them to the ``stats.yaml`` file, marking each value with the appropriate keys for UI display (ie. masked or copyable). The configurator is executed in the ``docker_entrypoint.sh`` file.
.. code:: typescript
:caption: Properties Type
interface PropertiesString {
type: 'string'
name: string
value: string
description: string | null
copyable: boolean
qr: boolean
masked: boolean
}
interface PropertiesObject {
type: 'object'
name: string
value: PropertiesObject | PropertiesString
}
Example
-------

2
site/source/support/faq/faq-services.rst
View File

@@ -96,4 +96,4 @@ By reading the descriptions in the link above, as well as doing some extra searc
We translated much of (but not all of) the tons of options into a clean and easy-to-use GUI with toggles, dropdowns, inputs, etc, which is what you're seeing in your config screen. If you notice the little "?" icons on the left of each option, clicking them will provide a brief description as to what the option does. Also, our config GUI restricts the possible values you can enter such that you don't accidentally crash Bitcoin. That said, be very careful about just randomly changing things, lest your node starts to behave strangely.
You can also check out our :ref:`Service Config Spec <configuration>` documentation for further details.
You can also check out our :ref:`Service Config Spec <config_spec>` documentation for further details.