dnsmanagerd man-page update regarding logging facility, mostly.

This commit is contained in:
Philippe Pittoli 2024-12-13 01:42:46 +01:00
parent 30d5f1d4a3
commit c4374c05be

View File

@ -49,8 +49,8 @@ accepted_domains:
.in .in
In this example, indexes are recreated, which is related to the In this example, indexes are recreated, which is related to the
.Xr dodb 7 .Xr DoDB
document database, see the related manual page to learn more. document database, see the related documentation to learn more.
Also, there is a list of accepted domains for Also, there is a list of accepted domains for
.Xr dnsmanagerd .Xr dnsmanagerd
to handle. to handle.
@ -61,94 +61,116 @@ The following presents the complete list of configuration file variables.
Generic Generic
.Xr libipc 7 .Xr libipc 7
related variables: related variables:
.
.Bl -tag -width " print functions" -compact .Bl -tag -width " print functions" -compact
.It Li ipc_timer .It Li ipc_timer
Int32, 30_000 (30 seconds) Int32, 30_000
. .br
The IPC timer wakes the process by default every 30 seconds.
There is no much point changing this value since nothing is executed periodically anyway, at least for now.
.It Li verbosity .It Li verbosity
Int32, 4 ([0-4], Int32, 4
.br
[0-4],
.Dq 0 .Dq 0
being quiet and being quiet and
.Dq 4 .Dq 4
meaning printing debug values) meaning printing debug values.
.
.It Li print functions
Print functions enable to select messages to print, for example by printing a message each time a message is received while ignoring keepalive messages.
.Bl -tag -width " print_ipc_message_received" -compact .It Li ipc_messages_to_show
.It Li print_ipc_timer Array of
Bool, false .Vt Baguette::Configuration::IPC::MESSAGE ,
.It Li print_ipc_connection [ERROR, EXCEPTION]
Bool, false
.It Li print_ipc_disconnection Types of IPC messages to print, for example all connections.
Bool, false This is mainly for debug since it is very low-level.
.It Li print_ipc_extra_socket High-level messages are more relevant to log.
Bool, false By default, errors and exceptions are logged.
.It Li print_ipc_message_received
Bool, false See
.It Li print_ipc_message_sent .Xr Baguette-crystal-base ,
Bool, false which includes the
.It Li print_ipc_switch .Vt Baguette::Configuration::IPC::MESSAGE
Bool, false definition.
.It Li print_ipc_error This type has an alias in
Bool, true .Xr dnsmanager :
.It Li print_ipc_exception .Vt IPCMESSAGE .
Bool, true
.It Li print_keepalive .It Li service_name
Bool, false String,
.El .Dq dnsmanager
. .br
.Xr libipc 7
unix socket name.
.El .El
Specific Specific
.Xr dnsmanagerd .Xr dnsmanagerd
variables: variables:
.Bl -tag -width "template_directory" -compact .Bl -tag -width "template_directory" -compact
.It Li service_name .It Li log_file
String, String?,
.Dq dnsmanager .Em none
(\c .br
.Xr libipc 7 Path to the log file.
unix socket name)
.It Li messages_to_mask
Array of
.Vt DNSManager::MESSAGE ,
.Em [ KEEPALIVE ]
.br
List of high-level
.Em dnsmanagerd
messages to mask in the logs.
.br
The type
.Vt DNSManager::MESSAGE
has an alias:
.Vt DNSMESSAGE .
.It Li recreate_indexes .It Li recreate_indexes
Bool, false (see Bool, false
.Xr dodb 7 .br
man-page) See
.Xr DoDB
documentation.
.It Li storage_directory .It Li storage_directory
String, String,
.Pa ./db-dnsmanagerd .Pa ./db-dnsmanagerd
(see .br
.Xr dodb 7 See
man-page) .Xr DoDB
documentation.
.It Li login .It Li login
String,
.Dq dnsmanager
.br
.Xr dnsmanagerd .Xr dnsmanagerd
needs to connect itself to needs to connect itself to
.Xr authd 1 .Xr authd 1
with an admin account to then authenticate its users. with an admin account to then authenticate its users.
String,
.Dq dnsmanager
.It Li pass .It Li pass
String?, String?,
.Em none .Em none
.It Li template_directory .It Li template_directory
String,
.Pa /etc/dnsmanager/templates
.br
New domains require to load a template so users won't have to enter some necessary entries themselves. New domains require to load a template so users won't have to enter some necessary entries themselves.
For example, SOA and NS RRs are pre-loaded and updated by an administrator when required. For example, SOA and NS RRs are pre-loaded and updated by an administrator when required.
.br .br
See See
.Pa tools/write-template-zone-file.cr .Pa tools/write-template-zone-file.cr
String,
.Pa /etc/dnsmanager/templates
.It Li accepted_domains .It Li accepted_domains
List of all accepted domains. Example: netlib.re.
Array of String, [] Array of String, []
.br
List of all accepted domains. Example: netlib.re.
.El .El
.Sh Options .Sh Options
@ -191,10 +213,9 @@ Recreate database indexes (symbolic links).
Path of the directory where the Path of the directory where the
.Xr dnsmanagerd .Xr dnsmanagerd
database is stored. database is stored.
See See the
.Xr dodb 7 .Xr DoDB
for more information. documentation.
.
.It Fl -accepted-domains No domains .It Fl -accepted-domains No domains
Accepted domains, coma separated. Accepted domains, coma separated.
@ -257,24 +278,30 @@ a command-line-interface client for
. .
.It Xr mailer 1 .It Xr mailer 1
a simple executable to send mails based on templates a simple executable to send mails based on templates
.
.It Xr dodb 7
a document database library used in
.Xr authd .
.El .El
The Document-oriented DataBase (DoDB) library used in
.Xr dnsmanagerd .
.br
.Lk https://git.baguette.netlib.re/Baguette/dodb.cr dodb
The online service The online service
.Dq netlib.re .Dq netlib.re
provides an interface for the provides an interface for the
.Xr dnsmanagerd .Xr dnsmanagerd
daemon. daemon.
.br .br
.Lk https://netlib.re netlib.re .Lk https://www.netlib.re netlib.re
The source code of the web interface: The source code of the web interface:
.br .br
.Lk https://git.baguette.netlib.re/Baguette/dnsmanager-webclient web-client .Lk https://git.baguette.netlib.re/Baguette/dnsmanager-webclient web-client
The logging and configuration library for the whole
.Dq baguette
project.
.br
.Lk https://git.baguette.netlib.re/Baguette/baguette-crystal-base baguette-crystal-base
.Sh Limitations .Sh Limitations
TODO: expand the documentation TODO: expand the documentation