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 this example, indexes are recreated, which is related to the
.Xr dodb 7
document database, see the related manual page to learn more.
.Xr DoDB
document database, see the related documentation to learn more.
Also, there is a list of accepted domains for
.Xr dnsmanagerd
to handle.
@ -61,94 +61,116 @@ The following presents the complete list of configuration file variables.
Generic
.Xr libipc 7
related variables:
.
.Bl -tag -width " print functions" -compact
.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
Int32, 4 ([0-4],
Int32, 4
.br
[0-4],
.Dq 0
being quiet and
.Dq 4
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.
meaning printing debug values.
.Bl -tag -width " print_ipc_message_received" -compact
.It Li print_ipc_timer
Bool, false
.It Li print_ipc_connection
Bool, false
.It Li print_ipc_disconnection
Bool, false
.It Li print_ipc_extra_socket
Bool, false
.It Li print_ipc_message_received
Bool, false
.It Li print_ipc_message_sent
Bool, false
.It Li print_ipc_switch
Bool, false
.It Li print_ipc_error
Bool, true
.It Li print_ipc_exception
Bool, true
.It Li print_keepalive
Bool, false
.El
.
.It Li ipc_messages_to_show
Array of
.Vt Baguette::Configuration::IPC::MESSAGE ,
[ERROR, EXCEPTION]
Types of IPC messages to print, for example all connections.
This is mainly for debug since it is very low-level.
High-level messages are more relevant to log.
By default, errors and exceptions are logged.
See
.Xr Baguette-crystal-base ,
which includes the
.Vt Baguette::Configuration::IPC::MESSAGE
definition.
This type has an alias in
.Xr dnsmanager :
.Vt IPCMESSAGE .
.It Li service_name
String,
.Dq dnsmanager
.br
.Xr libipc 7
unix socket name.
.El
Specific
.Xr dnsmanagerd
variables:
.Bl -tag -width "template_directory" -compact
.It Li service_name
String,
.Dq dnsmanager
(\c
.Xr libipc 7
unix socket name)
.It Li log_file
String?,
.Em none
.br
Path to the log file.
.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
Bool, false (see
.Xr dodb 7
man-page)
Bool, false
.br
See
.Xr DoDB
documentation.
.It Li storage_directory
String,
.Pa ./db-dnsmanagerd
(see
.Xr dodb 7
man-page)
.br
See
.Xr DoDB
documentation.
.It Li login
String,
.Dq dnsmanager
.br
.Xr dnsmanagerd
needs to connect itself to
.Xr authd 1
with an admin account to then authenticate its users.
String,
.Dq dnsmanager
.It Li pass
String?,
.Em none
.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.
For example, SOA and NS RRs are pre-loaded and updated by an administrator when required.
.br
See
.Pa tools/write-template-zone-file.cr
String,
.Pa /etc/dnsmanager/templates
.It Li accepted_domains
List of all accepted domains. Example: netlib.re.
Array of String, []
.br
List of all accepted domains. Example: netlib.re.
.El
.Sh Options
@ -191,10 +213,9 @@ Recreate database indexes (symbolic links).
Path of the directory where the
.Xr dnsmanagerd
database is stored.
See
.Xr dodb 7
for more information.
.
See the
.Xr DoDB
documentation.
.It Fl -accepted-domains No domains
Accepted domains, coma separated.
@ -257,24 +278,30 @@ a command-line-interface client for
.
.It Xr mailer 1
a simple executable to send mails based on templates
.
.It Xr dodb 7
a document database library used in
.Xr authd .
.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
.Dq netlib.re
provides an interface for the
.Xr dnsmanagerd
daemon.
.br
.Lk https://netlib.re netlib.re
.Lk https://www.netlib.re netlib.re
The source code of the web interface:
.br
.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
TODO: expand the documentation