authd
man-page update regarding logging facility, mostly.
This commit is contained in:
parent
c1304add81
commit
4cd40ef8a6
116
man/authd.1
116
man/authd.1
@ -58,8 +58,8 @@ to encrypt users's password is read from the file
|
|||||||
.Pa /var/authd/secret-password .
|
.Pa /var/authd/secret-password .
|
||||||
.br
|
.br
|
||||||
Finally, indexes are recreated, which is related to the
|
Finally, 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.
|
||||||
|
|
||||||
.Sh Configuration file variables
|
.Sh Configuration file variables
|
||||||
The following presents the complete list of configuration file variables.
|
The following presents the complete list of configuration file variables.
|
||||||
@ -70,50 +70,72 @@ 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 authd :
|
||||||
.It Li print_ipc_exception
|
.Vt IPCMESSAGE .
|
||||||
Bool, true
|
|
||||||
.It Li print_keepalive
|
.It Li service_name
|
||||||
Bool, false
|
String,
|
||||||
|
.Dq auth
|
||||||
|
.br
|
||||||
|
.Xr libipc 7
|
||||||
|
unix socket name.
|
||||||
.El
|
.El
|
||||||
.
|
|
||||||
.El
|
.El
|
||||||
|
|
||||||
Specific
|
Specific
|
||||||
.Xr authd
|
.Xr authd
|
||||||
variables:
|
variables:
|
||||||
.Bl -tag -width " print_password_recovery_parameters" -compact
|
.Bl -tag -width " print_password_recovery" -compact
|
||||||
.It Li service_name
|
.It Li log_file
|
||||||
String,
|
String?,
|
||||||
.Dq auth
|
.Em none
|
||||||
|
.br
|
||||||
|
Path to the log file.
|
||||||
|
|
||||||
|
.It Li messages_to_mask
|
||||||
|
Array of
|
||||||
|
.Vt AuthD::MESSAGE ,
|
||||||
|
.Em [ KEEPALIVE ]
|
||||||
|
.br
|
||||||
|
List of high-level
|
||||||
|
.Em authd
|
||||||
|
messages to mask in the logs.
|
||||||
|
.br
|
||||||
|
The type
|
||||||
|
.Vt AuthD::MESSAGE
|
||||||
|
has an alias:
|
||||||
|
.Vt AUTHMESSAGE .
|
||||||
|
|
||||||
.It Li recreate_indexes
|
.It Li recreate_indexes
|
||||||
Bool, false
|
Bool, false
|
||||||
.It Li storage_directory
|
.It Li storage_directory
|
||||||
@ -250,13 +272,27 @@ to handle users (authentication, authorization, preferences and profile)
|
|||||||
.It
|
.It
|
||||||
.Xr mailer 1
|
.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 authd .
|
||||||
|
.br
|
||||||
|
.Lk https://git.baguette.netlib.re/Baguette/dodb.cr dodb
|
||||||
|
|
||||||
|
The online service
|
||||||
|
.Dq netlib.re
|
||||||
|
is the first one to use the
|
||||||
|
.Xr authd
|
||||||
|
daemon.
|
||||||
|
.br
|
||||||
|
.Lk https://www.netlib.re netlib.re
|
||||||
|
|
||||||
|
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
|
||||||
WARNING:
|
WARNING:
|
||||||
.Xr authd
|
.Xr authd
|
||||||
|
Loading…
Reference in New Issue
Block a user