-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathsnowbox.8.html
275 lines (181 loc) · 5.32 KB
/
snowbox.8.html
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
Content-type: text/html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of SNOWBOX</TITLE>
</HEAD><BODY>
<H1>SNOWBOX</H1>
Section: Maintenance Commands (8)<BR>Updated: 6 May 2013<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<P>
<A NAME="lbAB"> </A>
<H2>NAME</H2>
snowbox - a POP3 server
<P>
<A NAME="lbAC"> </A>
<H2>SYNPOSIS</H2>
<B>snowbox [--configfile]</B>
<P>
<A NAME="lbAD"> </A>
<H2>DESCRIPTION</H2>
Snowbox is a POP3 server written in Go. It supports SSL and IPv6.
<P>
<B>Configuration</B>
<P>
The default configuration file is /etc/snowbox/config. This file must exist, even if it is empty. In this case internal (sane) defaults are used. The default config creates a listener on localhost pop3/110.
<P>
<B>Server config</B>
<BR>
(/etc/snowbox/config)
<P>
<B>listen (default=127.0.0.1:110)</B>
<BR>
Interface and port to listen on. Use 0.0.0.0:110 to bind to all available interfaces.
<P>
<B>use_ssl (default=no)</B>
<BR>
Activates pop3s. Needs an SSL certificate. See
<B>ssl_key</B>
and
<B>ssl_cert</B>
below.
<P>
<B>ssl_only (default=no)</B>
<BR>
If set to 'yes', only pop3s will be activated.
<P>
<B>listen_ssl (default=127.0.0.1:995)</B>
<BR>
Interface and port to use for pop3s. Use 0.0.0.0:995 to bind to all available interfaces.
<P>
<B>ssl_key (default=/etc/snowbox/snowbox.key)</B>
<BR>
SSL key file in PEM format.
<P>
<B>ssl_cert (default=/etc/snowbox/snowbox.cert)</B>
<BR>
SSL certificate file in PEM format.
<P>
<B>authfile (default=/etc/snowbox/user.auth)</B>
<BR>
This is the location of the user authentication file. See the section below for the format description.
<P>
<B>maildir (default=/var/mail)</B>
<BR>
This is the location of the system's mail spool directory. Usually this is
/var/mail where your MTA dumps mails.
<P>
<B>maildir_gid (default=mail)</B>
<BR>
This is the group ID of the mail spool directory. This is unused in the Go version of snowbox.
<P>
<B>loglevel (default=1)</B>
<BR>
For normal operation leave loglevel at default setting (1). Possible values
are:
<BR>
0: disable logging
<BR>
1: default
<BR>
2: unusual events usually only interesting for debugging
<BR>
3: logs every connection and sent command. Aka "I want more noise in my syslog" mode.
<P>
<B>logfacility (default=syslog)</B>
<BR>
Valid options are syslog or stdout (which is mainly useful for debugging and testing).
<P>
<B>maildir (default=/var/mail)</B>
<BR>
The directory of the maildrop. Usually /var/mail.
<P>
<B>maildir_gid:</B>
<BR>
This option is unused in snowbox 2. The process will run as root all the time since at the time of writing there was no way to change the user ID of a running Go routine.
<P>
<B>IPv6</B>
<P>
You can use IPv6 addresses for the listen and listen_ssl config options. The format is [IP]:port. To listen on all interfaces use [::]:port. Note that 0.0.0.0:port also binds to IPv6 when available.
<P>
<B>User config</B>
<BR>
(/etc/snowbox/user.auth)
<P>
This is the user authentication file. It should be owned by root and have
strict file permissions. The default format is:
<P>
username:<blank space> password
<P>
The blank space can be whitespaces or tabs and as much you need for funny
looking ASCII art config files. (It is matched with regular expression *)
<P>
<B>Examples:</B>
<P>
kiza: foobar
<BR>
bar: foo
<BR>
foo: bar
<P>
<B>Advanced configuration options</B>
<P>
The custom maildrop configuration from version 1.x is not supported yet.
<P>
<B>SSL</B>
<P>
You can create a self-signed certificate with the following command line:
<BR>
openssl req -new -x509 -nodes -out snowbox.cert -keyout snowbox.key -days 365 -subj '/CN=localhost'
<P>
where 'CN=localhost' is the hostname you want to use.
<P>
Snowbox can use PEM encoded certificates and keys.
<P>
<B>Launching snowbox</B>
<P>
An init.d script is provided with the package. There is a very simple one that is installed by default. If you are on Debian you can use the debianized version in init.d/debian. The deb package installs that one by default.
<P>
That's it. You should be able to use the server now. If you encounter a bug or have a problem with the configuration you can contact me at <A HREF="mailto:[email protected]">[email protected]</A>.
<P>
<A NAME="lbAE"> </A>
<H2>OPTIONS</H2>
<B>--configfile,</B>
Specify a different config file to load.
<P>
<A NAME="lbAF"> </A>
<H2>FILES</H2>
/usr/local/sbin/snowbox
<BR>
/etc/snowbox/config
<BR>
/etc/snowbox/user.auth
<BR>
/etc/init.d/snowbox
<P>
<A NAME="lbAG"> </A>
<H2>AUTHOR</H2>
Oliver Feiler <<A HREF="mailto:[email protected]">[email protected]</A>>
<BR>
Additional code and ideas: Rene Puls <<A HREF="mailto:[email protected]">[email protected]</A>>
<P>
<A NAME="lbAH"> </A>
<H2>LICENSE</H2>
Snowbox is released under the GNU General Public License version 3.
<P>
<HR>
<A NAME="index"> </A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNPOSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">OPTIONS</A><DD>
<DT><A HREF="#lbAF">FILES</A><DD>
<DT><A HREF="#lbAG">AUTHOR</A><DD>
<DT><A HREF="#lbAH">LICENSE</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 07:56:18 GMT, May 20, 2013
</BODY>
</HTML>