-
Notifications
You must be signed in to change notification settings - Fork 1
/
newsd.conf.pod.in
308 lines (194 loc) · 8.39 KB
/
newsd.conf.pod.in
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
=head1 NAME
newsd.conf - configuration files for erco's simple nntp news server
=head1 DESCRIPTION
I<Newsd(8)> is a standalone local NNTP news server for private
newsgroup serving on a single server. It is useful for serving
private newsgroup(s) to an intranet or the Internet and can act
as a simple mail gateway, however it does not interface with
other news servers and cannot manage distributed news feeds,
i.e. Usenet news.
I<Newsd> uses three types of configuration files for each
instance of the server: a global configuration file called
"newsd.conf", a per-group configuration file called ".config",
and a per-group status file called ".info".
=head1 THE NEWSD.CONF FILE
By default, I<newsd> reads the file /etc/newsd.conf
to obtain the global configuration for the server. The file is
simple text and uses the "#" character to start comments. Each
configuration line consists of a case-insensitive directive and
a value separated by whitespace, for example:
ServerName foo.bar.com
The following directives are supported:
=over
=item ErrorLog value
Specifies the file to use for logging information, errors, and
debugging information. "stderr" specifies that the messages
should be sent to the standard error file. "syslog" specifies
that the messages should be logged via the syslog interface. If
I<value> begins with the pipe (|) character, the rest of the
value is treated as a command to pipe the error messages into.
Otherwise, I<value> is treated as an absolute filename. The
default is "stderr".
=item HostnameLookups value
When a client connects to the news server, this directive
controls whether the server looks up the client's IP address.
I<Value> can be "off" to disable IP address lookups (the IP
address will be logged instead), "on" to enable IP address
lookups, or "double" to enable IP address lookup and
verification. The default is "off".
=item Listen address:port
=item Listen port
Listens on the specified address and/or port number for new
connections. I<Address> can be an IP address, hostname, or "*"
to specify the "any" address; if no address is specified, "*" is
assumed. I<Port> can be a port number or TCP service name. The
default is to listen on address "*" (any) and port "nntp" (119).
=item LogLevel value
Specifies the amount of information to log; "error" specifies
that only error messages should be logged. "info" specifies that
informational and error messages should be logged. "debug"
specifies that debugging, informational, and error messages
should be logged. The default is "info".
=item MaxClients number
Specifies the maximum number of simultaneous clients. If
I<number> is 0, then there is no limit. The default is 0.
=item MaxLogSize value
Specifies the maximum size for the newsd log file before it's
automatically rotated. Value is in bytes. A value of 0 disables
automatic size checks. The default is 1000000.
=item ServerName name
Specifies the hostname that is reported to clients. The default
is the name reported by I<hostname(1)>.
=item SendMail command
Specifies the command to use when sending mail messages. The
default is "@sendmail@".
=item SpoolDir directory
Specifies the root directory for newsgroup files and directories.
The default is "@spooldir@".
=item Timeout seconds
Specifies the number of seconds to keep an idle news client
connection open; specify 0 to disable the idle timeout. The
default is 43200 seconds (12 hours).
=item User name
Specifies the user account the I<newsd> process will run
under. The default user account is "news".
=back
=head1 NEWSGROUP FILES AND DIRECTORY
The /var/spool/news directory contains all the newsgroups and
articles with one file per article and one directory per
newsgroup.
The directory hierarchy dictates the available news
groups, e.g.
/var/spool/news/rush/general
is the directory for the 'rush.general' news group, and
in that directory will be one file per news article, each
filename being the article's number, eg:
/var/spool/news/rush/general/1
/var/spool/news/rush/general/2
/var/spool/news/rush/general/3
would be the pathnames for the three news articles whose
article numbers are 1, 2 and 3. Each article contains the
complete ascii text of the article, including the article's
header and message body, as per RFC 1036.
The directory permissions should be:
chown -R news.news /var/spool/news
find /var/spool/news -type d -exec chmod 755 {} \;
find /var/spool/news -type f -exec chmod 644 {} \;
Each active newsgroup's directory has its own .config file. For
example, the newsgroup 'rush.general' would have a .config file
called:
/var/spool/news/rush/general/.config
which might look like:
description Rush render queue discussion group
creator news@news.domain.com
postok 1
postlimit 1000
ccpost erco@domain.com
replyto -
Any newsgroup directory that does I<not> have a .config file
will not show up in users' news readers.
Manual modification of these files should be done carefully if
the I<newsd> daemon is running. Do the following to prevent
I<newsd> from loading a file while it is being edited:
1) Make a copy of the file called ".config.new".
2) Modify the copy.
3) Rename the copy to ".config" to make it take effect.
=head1 THE .CONFIG FILE FORMAT
Each group's .config file is in a simple plain text format similar
to newsd.conf:
=over
=item description text
Specifies the one line description of this group, which shows up
when people first subscribe to the newsgroup.
=item creator email-address
Specifies the email address of the owner of this group. Where
mail should be sent regarding questions about the maintenance
and administration of the group. This address is also used as
the Errors-To: address for all email messages sent by
\fRnewsd\fB.
=item postok value
Controls whether articles can be posted to this group. "0"
indicates posting is not allowed (read-only group) while "1"
indicates anyone can post to this group. The default value is
"1".
=item postlimit number-lines
Specifies the maximum number of lines in an article. Articles
will be rejected if they exceed this value. Set this value to
"0" to disable the limit. The default limit is "1000".
=item ccpost address[,address,...]
=item ccpost -
Sets the list of email addresses to be cc'ed whenever a posting
is made to the group. If set to '-', no email is sent. A single
line of addresses may not exceed 255 characters; to make longer
lists of addresses, use separate lines, eg:
ccpost a@foo.com,b@foo.com,c@foo.com
ccpost d@foo.com
Or to make things more readable, use one address per line:
ccpost a@foo.com
ccpost b@foo.com
ccpost c@foo.com
The default is "-".
=item replyto email-address
=item replyto -
Specifies an email address for the Reply-To header. This forces
replies to be sent to the specifies address, typically a mail
gateway back to the newsgroup. If set to "-", no Reply-To header
will be sent. The default is "-".
=back
=head1 .INFO FILES
I<newsd> automatically creates and maintains little ".info"
files in each active group's directory. Each file maintains
runtime information about that group's news articles.
Normally these files are automatically created and maintained,
and should not be administered by hand unless manually fixing
a problem, in which case the daemon should not be running.
=head1 SEE ALSO
=over
=item newsd(8) -- erco's simple nntp news server
=item RFC 977 -- NNTP Protocol
=item RFC 2890 -- NNTP extensions
=item RFC 1036 -- Usenet news messages format
=back
=head1 REPORTING BUGS
Report bugs using the form at "http://www.easysw.com/~mike/newsd/".
=head1 SUPPORTED NEWS READERS
I<newsd> has been tested with Netscape, Mozilla, Microsoft
Outlook and the tin(1) threaded news readers only. It should
work with most NNTP news readers, however.
=head1 AUTHORS
=over
=item Greg Ercolano, Topanga CA
=item Mike Sweet, Hollywood, MD
=back
=head1 COPYRIGHT
I<newsd> is copyright 2002-2004 by Greg Ercolano and Michael
Sweet. This program is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
=head1 NO WARRANTY
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
=cut