l3q/l3q.conf.5

.TH L3Q.CONF "5" "October 2023" "l3q client config file" "File Formats Manual"
.SH NAME
l3q.conf \- Config file for the l3q client (l3q)
.SH SYNOPSIS
/etc/l3q/l3q.conf
.SH DESCRIPTION
.\" Add any additional description here
.PP
The l3q.conf is the configuration file for the l3q client. The only and default path to the file is: /etc/l3q/l3q.conf
.br
The config file contains settings for l3q daemon connection over network and l3q client behaviour.
.SH SYNTAX
.PP
The configuration file consists of sections, each led by a [section] header, followed by key/value entries separated by a specific string (= or : ). Section names are case sensitive but keys are not. Leading and trailing whitespace is removed from keys and values. Values can also span multiple lines, as long as they are indented deeper than the first line of the value. Blank lines are ignored.
.PP
A valid section name can be any string that does not contain ‘\\n’ or ‘]’.
.PP
The configuration files may include comments, prefixed by specific characters (# and ; ). Comments may appear on their own on an otherwise empty line, possibly indented. 
.SH OPTIONS
There are two section available in the config file, the l3q daemon section: \fB[l3q_daemon]\fR
.br
and the l3q client section: \fB[l3q_client]\fR.
.TP
\fB[l3q_daemon]l3qd_host\fR
Default value: No default value, value is required.
.br
This is the IP address or host name (DNS-name) to the server where the l3q daemon is running. This variable is required or else the client will not be able to talk to the server.
.TP
\fB[l3q_daemon]l3qd_port\fR
Default value: 39911
.br
This is the port that the l3q daemon is listening on. If the l3q daemon is using the default port, this variable is not required but if the server port has been changed then this variable has to be set to the same value.
.TP
\fB[l3q_client]validate_file\fR
Default value: /etc/l3q/network.l3q
.br
This is the validation file that will validate the client with the server. If this file has not been configured the daemon will refuse connections from this client. To configure this file run the following command on the l3q daemon server as root: \fBl3qd --validate-host\fR
.br
and follow the instructions printed to terminal.
.TP
\fB[l3q_client]group\fR
Default value: l3q
.br
This is the group that all users must be a part of to be allowed to use the l3q client (l3q). If user is not a part of the group access is denied. If this parameter is changed the parameter \fB[l3qd]user_group\fR in the config file for the l3q daemon must be updated as well.
.br
File: /etc/l3q/l3qd.conf
.br
.SH AUTHOR
Written by Marcus Pedersén
.SH "REPORTING BUGS"
<https://notabug.org/marcux/l3q>
.SH COPYRIGHT
Copyright \(co 2023 Marcus Pedersén
.br
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
l3q(1)