summaryrefslogtreecommitdiff
path: root/doc/index.html
blob: e0e632666f14a029a0fb1037c9c6dabe168ee851 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Language" content="en" />
    <title>smtpd-starttls-proxy - A proxy implementing STARTTLS in front of SMTP servers that do not</title>
    <meta name="Description" content="smtpd-starttls-proxy - A proxy implementing STARTTLS in front of SMTP servers that do not" />
    <meta name="Keywords" content="smtpd starttls proxy qmail-smtpd ucspi-tls laurent bercot ska skarnet" />
    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
  </head>
<body>

<p>
<a href="//skarnet.org/software/">Software</a><br />
<a href="//skarnet.org/">skarnet.org</a>
</p>

<h1> smtpd-starttls-proxy </h1>

<h2> What is it&nbsp;? </h2>

<p>
  smtpd-starttls-proxy is a package implementing STARTTLS for
inetd-like mail servers that do not already support STARTTLS.
</p>

<hr />

<h2> Installation </h2>

<h3> Requirements </h3>

<ul>
 <li> A POSIX-compliant system with a standard C development environment </li>
 <li> GNU make, version 3.81 or later </li>
 <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
2.10.0.3 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the skalibs
library. </li>
 <li> <a href="//skarnet.org/software/s6/">s6</a> version
2.10.0.3 or later. It's a build-time and run-time requirement. </li>
 <li> Recommended at run-time: <a href="//skarnet.org/software/s6-networking/">s6-networking</a> version
2.4.1.1 or later. It's not a requirement, but you won't be able
to do much with smtpd-starttls-proxy if you don't have a suitable
UCSPI-TLS server tool, and <a href="//skarnet.org/software/s6-networking/">s6-networking</a>
provides a simple one. </li>
</ul>

<h3> Licensing </h3>

<p>
 smtpd-starttls-proxy is free software. It is available under the
<a href="https://opensource.org/licenses/ISC">ISC license</a>.
</p>

<h3> Download </h3>

<ul>
 <li> The current released version of smtpd-starttls-proxy is
<em>none</em>, for now. It's only available via git. </li>
<!-- <a href="smtpd-starttls-proxy-0.0.1.0.tar.gz">0.0.1.0</a> </li> -->
 <li> You can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/smtpd-starttls-proxy/">smtpd-starttls-proxy
git repository</a>:
<pre> git clone git://git.skarnet.org/smtpd-starttls-proxy </pre> </li>
 <li> There's also a
<a href="https://github.com/skarnet/smtpd-starttls-proxy">GitHub mirror</a>
of the smtpd-starttls-proxy git repository. </li>
</ul>

<h3> Compilation </h3>

<ul>
 <li> See the enclosed INSTALL file for installation details. </li>
</ul>

<h3> Upgrade notes </h3>

<ul>
 <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between
the previous versions of smtpd-starttls-proxy and the current one. </li>
</ul>

<hr />

<h2> Reference </h2>

<h3> Commands </h3>

<ul>
<li><a href="smtpd-starttls-proxy-io.html">The <tt>smtpd-starttls-proxy-io</tt> program</a></li>
</ul>

<h2> Related resources </h2>

<ul>
 <li> <tt>smtpd-starttls-proxy</tt> is discussed on the
<a href="//skarnet.org/lists/#skaware">skaware</a> mailing-list. </li>
</ul>

</body>
</html>