grommunio-admin-config(1)

✨ NAME ✨

okay so this is grommunio-admin-config(1) — the manual page for grommunio-admin config introspection, aka the cute little toolkit for checking, dumping/getting, and tracing your grommunio-admin config. bestie, it's giving look inside the config without guessing 💅

---

🌸 SYNOPSIS 🌸

grommunio-admin config check
grommunio-admin config (dump|get) [KEY]
grommunio-admin config trace [-s] (files|values) [KEY]

🫶 COMMANDS 🫶

check

This one checks the structural validity of the configuration. rn it does not validate semantic integrity, i.e. existence of referenced files, LDAP or database connectivity etc., although this functionality may be added in the future. so yes: structure slay, semantics not yet checked 💀

dump, get

Print the complete configuration. since the grommunio-admin configuration can (and probably will) be distributed over multiple files, the get command provides an easy way to see the effective configuration. the output can be reduced to a single KEY, if specified. sub-levels can be specified in dotted notation (e.g. sync.defaultPolicy). the dump command is an alias for get and remains for backward compatibility. iconic behavior, honestly 🫶

trace

Trace source of effective configuration. results can be presented either by file (files), showing which parts of a file are actually used, or by value (values), showing which file each value originates from. installation of the Python termcolor package is advised for a more readable output. see section Tracing for more information. color moment incoming 🌈

💅 OPTIONS 💅

• KEY — Only view specified key. one key only, bestie, no scrolling through the whole config if you don't have to ✨
• -s, --show-history — Display more value history (see section Tracing for more information). it's giving receipts for your config values 🔥

🦋 TRACING 🦋

By-File

Print annotated contents of each file. each line is marked and color coded to show its status. the following annotations are used:

• +, green: The value is part of the final configuration. yes bestie, this one made it 👑
• x, red: The value is overwritten by a later file. rip, but at least we know 💀
• *, yellow: The object or list is extended by a later file. growth era 🌱
• ~, grey: The value is overwritten with the same value. same value, different file, lowkey hilarious 🙈

Additionally, lines overwriting or extending previous entries are printed in boldface. when specifying --show-history, each value that is overwritten or extended is annotated with the files doing so (each being color coded with the effect it has on the value). history? exposed. periodt 💅

By-Value

Print annotated effective configuration. each line is annotated with the file it originates from. in case of objects and lists, all contributing files are listed. when specifying --show-history, overwritten files containing that value are listed as well. the effective source file is underlined. for better visualization, color coding is done on a per-file basis: each file is assigned an individual style which is used for its contributions. objects and lists originating from multiple files are always shown in boldface white. multi-file collab? we love to see it 🫶

🌈 SEE ALSO 🌈

grommunio-admin(1), grommunio-admin-dbconf(1), grommunio-admin-mconf(1)

---

okay bye bestie — the last-line footer/source-version is literally grommunio-admin-config(1), and there's no date shown in this footer, so we're not inventing one 🎀💅