.TH SUBRELAY.CONF 5
.SH NAME
subrelay.conf \- configuration file for the Subrelay daemon
.SH DESCRIPTION
.B subrelay.conf
contains settings used by
.BR subrelayd (8).
Each setting is written as a name, a colon, and a value. Values in the example
configuration are enclosed in single quotes.
.SH SETTINGS
.TP
.B MAILLIST_ADDR
Email address of the mailing list.
.TP
.B MAILLIST_NAME
Display name of the mailing list.
.TP
.B IMAP_HOST
Hostname of the external IMAP server used to listen for incoming messages.
.TP
.B IMAP_PORT
Port used to connect to the IMAP server.
.TP
.B SMTP_HOST
Hostname of the external SMTP server used to send messages.
.TP
.B SMTP_PORT
Port used to connect to the SMTP server.
.TP
.B ACCOUNT_PASS
Password for the account used by the daemon.
.TP
.B SOCKET_PATH
Path to the local UNIX socket used to communicate with the daemon.
.TP
.B SUBSCRIBERS_FILE
Path to the file used to store subscriber information.
.TP
.B TEMPLATE_PATH
Directory containing mail templates. The daemon currently supports
.I subscribe.txt
in this directory, which is used to compose subscription confirmation
messages.
.TP
.B RUN_USER
User account under which the daemon runs.
.TP
.B RUN_GROUP
Group under which the daemon runs.
.SH TEMPLATE
The
.I subscribe.txt
template is used to compose a subscription confirmation email. It may contain
the following substitutions:
.TP
.B $MAILLIST_NAME
The value of
.BR MAILLIST_NAME .
.TP
.B $MAILLIST_ADDR
The value of
.BR MAILLIST_ADDR .
.TP
.B $CONFIRM_ADDR
The address to which the recipient should reply or send a blank message to
confirm the subscription.
.PP
The template begins with a
.B Subject:
line, followed by a blank line and the message body.
.SH EXAMPLE
.nf
MAILLIST_ADDR:    'subrelay@domain.tld'
MAILLIST_NAME:    'Mail list long name with some brief description'

IMAP_HOST:        'imap.domain.tld'
IMAP_PORT:        '993'
SMTP_HOST:        'smtp.domain.tld'
SMTP_PORT:        '587'
ACCOUNT_PASS:     'replace-this-password'

SOCKET_PATH:      '/var/run/subrelay/subrelayd.sock'
SUBSCRIBERS_FILE: '/etc/subrelay/subscribers.txt'
TEMPLATE_PATH:    '/etc/subrelay/templates'
RUN_USER:         'subrelay'
RUN_GROUP:        'subrelay'
.fi
.SH FILES
.TP
.I /etc/subrelay/subrelay.conf
Common location for the daemon configuration file; the actual path is supplied
when starting
.BR subrelayd (8).
.TP
.I /etc/subrelay/templates/subscribe.txt
Example location for the subscription confirmation template.
.SH SEE ALSO
.BR subrelayd (8),
.BR sbrtctrl (1)