serv/mox
1
1
Fork 0
mirror of https://github.com/mjl-/mox.git synced 2025-02-04 18:28:32 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

add a little explanation about sconf, the config file syntax

Browse source
This commit is contained in:
Mechiel Lukkien 2023-03-10 11:42:50 +01:00
parent f9eae88aba
commit 47b88550be
No known key found for this signature in database
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
config/doc.go
View file

@ -2,6 +2,11 @@
Package config holds the configuration file definitions for mox.conf (Static)
and domains.conf (Dynamic).
These config files are in "sconf" format. Summarized: Indent with tabs, "#" as
first non-whitespace character makes the line a comment (you cannot have a line
with both a value and a comment), strings are not quoted/escaped and can never
span multiple lines. See https://pkg.go.dev/github.com/mjl-/sconf for details.
Annotated empty/default configuration files you could use as a starting point
for your mox.conf and domains.conf, as generated by "mox config
describe-static" and "mox config describe-domains":

5
gendoc.sh
View file

@ -45,6 +45,11 @@ cat <<EOF
Package config holds the configuration file definitions for mox.conf (Static)
and domains.conf (Dynamic).
These config files are in "sconf" format. Summarized: Indent with tabs, "#" as
first non-whitespace character makes the line a comment (you cannot have a line
with both a value and a comment), strings are not quoted/escaped and can never
span multiple lines. See https://pkg.go.dev/github.com/mjl-/sconf for details.
Annotated empty/default configuration files you could use as a starting point
for your mox.conf and domains.conf, as generated by "mox config
describe-static" and "mox config describe-domains":