github.com/choria-io/go-choria@v0.28.1-0.20240416190746-b3bf9c7d5a45/internal/fs/misc/config_doc.templ (about)

     1  +++
     2  title = "Config Reference"
     3  toc = true
     4  weight = 40
     5  pre = "<b>4. </b>"
     6  +++
     7  
     8  This is a list of all known Configuration settings. This list is based on declared settings within the Choria Go code base and so will not cover 100% of settings - plugins can contribute their own settings which are note known at compile time.
     9  
    10  {{% notice secondary "Version Hint" code-branch %}}
    11  Built on *<<.Now>>* using version *<<.Version>>*
    12  {{% /notice %}}
    13  
    14  ### Run-time configuration
    15  
    16  The run-time configuration can be inspected using `choria tool config --config /etc/choria/server.cfg`, this will show the active configuration.
    17  
    18  ### Search and list directives
    19  
    20  In addition to the full list below you can get configuration information for your version using the CLI:
    21  
    22  ```nohighlight
    23  % choria tool config security.provider
    24  ....
    25  Configuration item: plugin.security.provider
    26  
    27  ║        Value: puppet
    28  ║    Data Type: string
    29  ║   Validation: enum=puppet,file,pkcs11,certmanager,choria
    30  ║      Default: puppet
    31  ║
    32  ║ The Security Provider to use
    33  ╙─
    34  ```
    35  
    36  ### Data Types
    37  
    38  A few special types are defined, the rest map to standard Go types
    39  
    40  |Type|Description|
    41  |----|-----------|
    42  |comma_split|A comma separated list of strings, possibly with spaces between|
    43  |duration|A duration such as `1h`, `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `ms`, `s`, `m`, `h`|
    44  |path_split|A list of paths split by a OS specific PATH separator|
    45  |path_string|A path that can include `~` for the users home directory|
    46  |strings|A space separated list of strings|
    47  |title_string|A string that will be stored as a `Title String`|
    48  
    49  ### Index
    50  
    51  | | |
    52  |-|-|
    53  <<- range $i, $k := .Keys >>
    54  |[<< index $k 0 >>](#<< index $k 0 | gha >>)|[<< index $k 1 >>](#<< index $k 1 | gha >>)|
    55  <<- end >>
    56  
    57  << range .Docs >>
    58  ### << .ConfigKey >>
    59  
    60   * **Type:** << .Type >>
    61  <<- if .URL >>
    62   * **Additional Information:** << .URL >>
    63  <<- end >>
    64  <<- if .Validation >>
    65   * **Validation:** << .Validation >>
    66  <<- end >>
    67  <<- if .Default >>
    68   * **Default Value:** << .Default >>
    69  <<- end >>
    70  <<- if .Environment >>
    71   * **Environment Variable:** << .Environment >>
    72  <<- end >>
    73  <<- if ne .Description "Undocumented" >>
    74  
    75  << .Description >><< end >>
    76  <<- if .Deprecate >>
    77  
    78  **This setting is deprecated or already unused**
    79  <<- end >>
    80  << end >>