Commit 25624b40 authored by Alberto Bertogli's avatar Alberto Bertogli

docs: Document submission_over_tls_address option

The submission_over_tls_address configuration option has existed for a
long time, but was not properly documented.

This patch adds it to the manpage, as well as printing it in the
configuration output on startup.
parent dade2041
Pipeline #61493 failed with stage
in 4 minutes and 41 seconds
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
......@@ -54,16 +54,20 @@
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
......@@ -129,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "chasquid.conf 5"
.TH chasquid.conf 5 "2018-06-06" "" ""
.TH chasquid.conf 5 "2019-07-15" "" ""
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
......@@ -138,7 +142,7 @@
chasquid.conf(5) \-\- chasquid configuration file
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fIchasquid.conf\fR\|(5) is \fIchasquid\fR\|(1)'s main configuration file.
\&\fBchasquid.conf\fR\|(5) is \fBchasquid\fR\|(1)'s main configuration file.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The file is in protocol buffers' text format.
......@@ -159,14 +163,19 @@ clients, for aesthetic purposes. Default: the system's hostname.
Maximum email size, in megabytes. Default: 50.
.IP "\fBsmtp_address\fR (repeated string):" 8
.IX Item "smtp_address (repeated string):"
Addresses to listen on for \s-1SMTP.\s0 Default: \*(L"systemd\*(R", which means systemd
passes sockets to us. systemd sockets must be named with
Addresses to listen on for \s-1SMTP\s0 (usually port 25). Default: \*(L"systemd\*(R", which
means systemd passes sockets to us. systemd sockets must be named with
\&\fBFileDescriptorName=smtp\fR.
.IP "\fBsubmission_address\fR (repeated string):" 8
.IX Item "submission_address (repeated string):"
Addresses to listen on for submission. Default: \*(L"systemd\*(R", which means
systemd passes sockets to us. systemd sockets must be named with
Addresses to listen on for submission (usually port 587). Default: \*(L"systemd\*(R",
which means systemd passes sockets to us. systemd sockets must be named with
\&\fBFileDescriptorName=submission\fR.
.IP "\fBsubmission_over_tls_address\fR (repeated string):" 8
.IX Item "submission_over_tls_address (repeated string):"
Addresses to listen on for submission-over-TLS (usually port 465). Default:
\&\*(L"systemd\*(R", which means systemd passes sockets to us. systemd sockets must be
named with \fBFileDescriptorName=submission_tls\fR.
.IP "\fBmonitoring_address\fR (string):" 8
.IX Item "monitoring_address (string):"
Address for the monitoring \s-1HTTP\s0 server. Do \s-1NOT\s0 expose this to the public
......@@ -224,4 +233,4 @@ overridden using the \f(CW\*(C`dovecot_userdb_path\*(C'\fR and \f(CW\*(C`dovecot
needed.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIchasquid\fR\|(1)
\&\fBchasquid\fR\|(1)
......@@ -33,16 +33,22 @@ Maximum email size, in megabytes. Default: 50.
=item B<smtp_address> (repeated string):
Addresses to listen on for SMTP. Default: "systemd", which means systemd
passes sockets to us. systemd sockets must be named with
Addresses to listen on for SMTP (usually port 25). Default: "systemd", which
means systemd passes sockets to us. systemd sockets must be named with
B<FileDescriptorName=smtp>.
=item B<submission_address> (repeated string):
Addresses to listen on for submission. Default: "systemd", which means
systemd passes sockets to us. systemd sockets must be named with
Addresses to listen on for submission (usually port 587). Default: "systemd",
which means systemd passes sockets to us. systemd sockets must be named with
B<FileDescriptorName=submission>.
=item B<submission_over_tls_address> (repeated string):
Addresses to listen on for submission-over-TLS (usually port 465). Default:
"systemd", which means systemd passes sockets to us. systemd sockets must be
named with B<FileDescriptorName=submission_tls>.
=item B<monitoring_address> (string):
Address for the monitoring HTTP server. Do NOT expose this to the public
......
......@@ -88,6 +88,7 @@ func LogConfig(c *Config) {
log.Infof(" Max data size (MB): %d", c.MaxDataSizeMb)
log.Infof(" SMTP Addresses: %v", c.SmtpAddress)
log.Infof(" Submission Addresses: %v", c.SubmissionAddress)
log.Infof(" Submission+TLS Addresses: %v", c.SubmissionOverTlsAddress)
log.Infof(" Monitoring address: %s", c.MonitoringAddress)
log.Infof(" MDA: %s %v", c.MailDeliveryAgentBin, c.MailDeliveryAgentArgs)
log.Infof(" Data directory: %s", c.DataDir)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment