1
0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-17 14:37:02 +00:00

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.
This commit is contained in:
Alberto Bertogli
2019-07-15 01:53:31 +01:00
parent dade2041db
commit 25624b406d
3 changed files with 35 additions and 19 deletions

View File

@@ -1,4 +1,4 @@
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\" .\"
.\" Standard preamble: .\" Standard preamble:
.\" ======================================================================== .\" ========================================================================
@@ -54,16 +54,20 @@
.\" Avoid warning from groff about undefined register 'F'. .\" Avoid warning from groff about undefined register 'F'.
.de IX .de IX
.. ..
.if !\nF .nr F 0 .nr rF 0
.if \nF>0 \{\ .if \n(.g .if rF .nr rF 1
. de IX .if (\n(rF:(\n(.g==0)) \{\
. tm Index:\\$1\t\\n%\t"\\$2" . if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
.. ..
. if !\nF==2 \{\ . if !\nF==2 \{\
. nr % 0 . nr % 0
. nr F 2 . nr F 2
. \}
. \} . \}
.\} .\}
.rr rF
.\" .\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts. .\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -129,7 +133,7 @@
.\" ======================================================================== .\" ========================================================================
.\" .\"
.IX Title "chasquid.conf 5" .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 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents. .\" way too many mistakes in technical documents.
.if n .ad l .if n .ad l
@@ -138,7 +142,7 @@
chasquid.conf(5) \-\- chasquid configuration file chasquid.conf(5) \-\- chasquid configuration file
.SH "SYNOPSIS" .SH "SYNOPSIS"
.IX Header "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" .SH "DESCRIPTION"
.IX Header "DESCRIPTION" .IX Header "DESCRIPTION"
The file is in protocol buffers' text format. 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. Maximum email size, in megabytes. Default: 50.
.IP "\fBsmtp_address\fR (repeated string):" 8 .IP "\fBsmtp_address\fR (repeated string):" 8
.IX Item "smtp_address (repeated string):" .IX Item "smtp_address (repeated string):"
Addresses to listen on for \s-1SMTP.\s0 Default: \*(L"systemd\*(R", which means systemd Addresses to listen on for \s-1SMTP\s0 (usually port 25). Default: \*(L"systemd\*(R", which
passes sockets to us. systemd sockets must be named with means systemd passes sockets to us. systemd sockets must be named with
\&\fBFileDescriptorName=smtp\fR. \&\fBFileDescriptorName=smtp\fR.
.IP "\fBsubmission_address\fR (repeated string):" 8 .IP "\fBsubmission_address\fR (repeated string):" 8
.IX Item "submission_address (repeated string):" .IX Item "submission_address (repeated string):"
Addresses to listen on for submission. Default: \*(L"systemd\*(R", which means Addresses to listen on for submission (usually port 587). Default: \*(L"systemd\*(R",
systemd passes sockets to us. systemd sockets must be named with which means systemd passes sockets to us. systemd sockets must be named with
\&\fBFileDescriptorName=submission\fR. \&\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 .IP "\fBmonitoring_address\fR (string):" 8
.IX Item "monitoring_address (string):" .IX Item "monitoring_address (string):"
Address for the monitoring \s-1HTTP\s0 server. Do \s-1NOT\s0 expose this to the public 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. needed.
.SH "SEE ALSO" .SH "SEE ALSO"
.IX Header "SEE ALSO" .IX Header "SEE ALSO"
\&\fIchasquid\fR\|(1) \&\fBchasquid\fR\|(1)

View File

@@ -33,16 +33,22 @@ Maximum email size, in megabytes. Default: 50.
=item B<smtp_address> (repeated string): =item B<smtp_address> (repeated string):
Addresses to listen on for SMTP. Default: "systemd", which means systemd Addresses to listen on for SMTP (usually port 25). Default: "systemd", which
passes sockets to us. systemd sockets must be named with means systemd passes sockets to us. systemd sockets must be named with
B<FileDescriptorName=smtp>. B<FileDescriptorName=smtp>.
=item B<submission_address> (repeated string): =item B<submission_address> (repeated string):
Addresses to listen on for submission. Default: "systemd", which means Addresses to listen on for submission (usually port 587). Default: "systemd",
systemd passes sockets to us. systemd sockets must be named with which means systemd passes sockets to us. systemd sockets must be named with
B<FileDescriptorName=submission>. 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): =item B<monitoring_address> (string):
Address for the monitoring HTTP server. Do NOT expose this to the public Address for the monitoring HTTP server. Do NOT expose this to the public

View File

@@ -88,6 +88,7 @@ func LogConfig(c *Config) {
log.Infof(" Max data size (MB): %d", c.MaxDataSizeMb) log.Infof(" Max data size (MB): %d", c.MaxDataSizeMb)
log.Infof(" SMTP Addresses: %v", c.SmtpAddress) log.Infof(" SMTP Addresses: %v", c.SmtpAddress)
log.Infof(" Submission Addresses: %v", c.SubmissionAddress) log.Infof(" Submission Addresses: %v", c.SubmissionAddress)
log.Infof(" Submission+TLS Addresses: %v", c.SubmissionOverTlsAddress)
log.Infof(" Monitoring address: %s", c.MonitoringAddress) log.Infof(" Monitoring address: %s", c.MonitoringAddress)
log.Infof(" MDA: %s %v", c.MailDeliveryAgentBin, c.MailDeliveryAgentArgs) log.Infof(" MDA: %s %v", c.MailDeliveryAgentBin, c.MailDeliveryAgentArgs)
log.Infof(" Data directory: %s", c.DataDir) log.Infof(" Data directory: %s", c.DataDir)