Skip to content

Commit 7622bc0

Browse files
phlogistonjohnmergify[bot]
authored andcommitted
docs: be clearer about what types top-level configs take
Signed-off-by: John Mulligan <[email protected]>
1 parent 2b13aa8 commit 7622bc0

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/configuration.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -156,16 +156,18 @@ configurations. A useable configuration file must have at least one
156156
configuration, but more than one is supported.
157157

158158
Each configuration section is as follows:
159-
* `instance_name` - A name for the configuration instance. Used for Samba's
160-
server (netbios) name.
161-
* `instance_features` - Optional list. Feature names that alter the high
162-
level behavior of sambacc. Valid feature flags are: `CTDB`, `ADDC`.
163-
* `shares` - List. The names of one or more share config sections to include
164-
as part of the sambacc configuration.
165-
* `globals` - List. The names of one or more global config sections to
166-
include as part of the sambacc configuration.
167-
* `domain_settings` - Only used with `ADDC` feature. Name of the AD DC
168-
domain configuration.
159+
* `instance_name` - String. A name for the configuration instance. Used for
160+
Samba's server (netbios) name. Valid for all configurations.
161+
* `instance_features` - List of strings. Feature flags that alter the
162+
high level behavior of sambacc. Valid feature flags are: `CTDB`, `ADDC`.
163+
* `shares` - List of strings. The names of one or more share config sections to
164+
include as part of the sambacc configuration. Valid only for file-server
165+
configurations (not supported for AD DC).
166+
* `globals` - List of strings. The names of one or more global config sections
167+
to include as part of the sambacc configuration. Valid for all
168+
configurations.
169+
* `domain_settings` - String. Name of the AD DC domain configuration. Required
170+
for AD DC configurations, invalid for all others.
169171

170172
The subsections under `configs` can be used to uniquely identify one server
171173
"instance". Because those server instances may repeat the shares and samba

0 commit comments

Comments
 (0)