source: archive/leafnode.xml

trunk
Last change on this file was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 3 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

  • Property mode set to 100644
File size: 11.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY leafnode-download-http "&sourceforge-repo;/leafnode/leafnode-&leafnode-version;.tar.bz2">
8 <!ENTITY leafnode-download-ftp "ftp://ftp.gwdg.de/pub/linux/mirrors/sunsite/system/news/transport/leafnode-&leafnode-version;.tar.bz2">
9 <!ENTITY leafnode-md5sum "88552c5cc91cb27146c8906b2d33289d">
10 <!ENTITY leafnode-size "428 KB">
11 <!ENTITY leafnode-buildsize "6.2 MB">
12 <!ENTITY leafnode-time "0.1 SBU">
13]>
14
15<sect1 id="leafnode" xreflabel="Leafnode-&leafnode-version;">
16 <?dbhtml filename="leafnode.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Leafnode-&leafnode-version;</title>
23
24 <indexterm zone="leafnode">
25 <primary sortas="a-Leafnode">Leafnode</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Leafnode</title>
30
31 <para><application>Leafnode</application> is an NNTP server designed
32 for small sites to provide a local USENET spool.</para>
33
34 <bridgehead renderas="sect3">Package Information</bridgehead>
35 <itemizedlist spacing="compact">
36 <listitem>
37 <para>Download (HTTP): <ulink url="&leafnode-download-http;"/></para>
38 </listitem>
39 <listitem>
40 <para>Download (FTP): <ulink url="&leafnode-download-ftp;"/></para>
41 </listitem>
42 <listitem>
43 <para>Download MD5 sum: &leafnode-md5sum;</para>
44 </listitem>
45 <listitem>
46 <para>Download size: &leafnode-size;</para>
47 </listitem>
48 <listitem>
49 <para>Estimated disk space required: &leafnode-buildsize;</para>
50 </listitem>
51 <listitem>
52 <para>Estimated build time: &leafnode-time;</para>
53 </listitem>
54 </itemizedlist>
55
56 <bridgehead renderas="sect3">Leafnode Dependencies</bridgehead>
57
58 <bridgehead renderas="sect4">Required</bridgehead>
59 <para role="required"><xref linkend="pcre"/> and
60 <xref linkend="tcpwrappers"/></para>
61
62 <bridgehead renderas="sect4">Recommended</bridgehead>
63 <para role="recommended">
64 <!-- <xref linkend="xinetd"/> and -->
65 <xref linkend="fcron"/>
66 </para>
67
68 <para condition="html" role="usernotes">User Notes:
69 <ulink url="&blfs-wiki;/leafnode"/></para>
70
71 </sect2>
72
73 <sect2 role="installation">
74 <title>Installation of Leafnode</title>
75
76 <para>As the <systemitem class="username">root</systemitem> user, create
77 the group and user <systemitem class="username">news</systemitem>,
78 if not present:</para>
79
80<screen role="root"><userinput>groupadd -g 36 news &amp;&amp;
81useradd -c "Leafnode News Server" -d /var/spool/news -g news \
82 -u 36 news</userinput></screen>
83
84 <para>Install <application>Leafnode</application> by running the following
85 commands:</para>
86
87<screen><userinput>./configure --prefix=/usr \
88 --localstatedir=/var --sysconfdir=/etc/leafnode \
89 --with-lockfile=/var/lock/leafnode/fetchnews.lck &amp;&amp;
90make</userinput></screen>
91 <para>To test the results, issue: <command>make check</command>.</para>
92 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
93
94<screen role="root"><userinput>make install</userinput></screen>
95
96 </sect2>
97
98 <sect2 role="commands">
99 <title>Command Explanations</title>
100
101 <para><parameter>--localstatedir=/var</parameter>: Change the default
102 spool directory of <filename class="directory">/usr/var</filename>.</para>
103
104 <para><parameter>--sysconfdir=/etc/leafnode</parameter>:
105 <application>Leafnode</application> reads its configuration data from a
106 file called <filename>config</filename> which will be created in
107 <filename class="directory">/etc/leafnode</filename> to
108 avoid any potential conflict with other packages.</para>
109
110 <para><command>make update</command>: Run this command if you are upgrading
111 from a very old version of <application>Leafnode</application>.</para>
112
113 </sect2>
114
115 <sect2 role="configuration">
116 <title>Configuring Leafnode</title>
117
118 <sect3 id="leafnode-config">
119 <title>Config Files</title>
120
121 <para><filename>/etc/leafnode/config</filename>,
122 <filename>/etc/nntpserver</filename>,
123 <filename>/etc/sysconfig/createfiles</filename>
124 <filename>/etc/inetd.conf</filename> or
125 <!-- <filename>/etc/xinetd.conf</filename> or
126 <filename>/etc/xinetd.d/nntp</filename>--></para>
127
128 <indexterm zone="leafnode leafnode-config">
129 <primary sortas="e-etc-leafnode-config">/etc/leafnode/config</primary>
130 </indexterm>
131
132 <indexterm zone="leafnode leafnode-config">
133 <primary sortas="e-etc-nntpserver">/etc/nntpserver</primary>
134 </indexterm>
135<!--
136 <indexterm zone="leafnode leafnode-config">
137 <primary sortas="e-etc-xinetd.conf">/etc/xinetd.conf</primary>
138 </indexterm>
139-->
140 <indexterm zone="leafnode leafnode-config">
141 <primary sortas="e-etc-inetd.conf">/etc/inetd.conf</primary>
142 </indexterm>
143
144 <indexterm zone="leafnode leafnode-config">
145 <primary sortas="e-etc-sysconfig-createfiles">/etc/sysconfig/createfiles</primary>
146 </indexterm>
147<!--
148 <indexterm zone="leafnode leafnode-config">
149 <primary sortas="e-etc-xinetd.d-nntp">/etc/xinetd.d/nntp</primary>
150 </indexterm>
151-->
152 </sect3>
153
154 <sect3>
155 <title>Configuration Information</title>
156
157 <para>The <filename>/etc/leafnode/config</filename> file must be
158 edited to reflect the name of the upstream NNTP provider. Copy the
159 example configuration file to <filename>/etc/leafnode/config</filename>
160 and save the original for reference:</para>
161
162<screen role="root"><userinput>cp /etc/leafnode/config.example /etc/leafnode/config</userinput></screen>
163
164 <para>Change the</para>
165
166<screen><literal>server = </literal></screen>
167
168 <para>entry to reflect your news provider.</para>
169
170 <para>The <filename>/etc/nntpserver</filename> file must contain
171 127.0.0.1 to prevent news clients from reading news from the upstream
172 feed. Create this file using the following command:</para>
173
174<screen role="root"><userinput>cat &gt; /etc/nntpserver &lt;&lt; "EOF"
175<literal>127.0.0.1</literal>
176
177EOF</userinput></screen>
178
179 <para>The <command>/etc/rc.d/init.d/cleanfs</command> script, part
180 of the LFS bootscript package, will remove the
181 <filename class="directory">/var/lock/leafnode</filename> directory
182 during the system boot sequence. Install the following line in the
183 <filename>/etc/sysconfig/createfiles</filename> file to re-create the
184 directory:</para>
185
186<screen><literal>/var/lock/leafnode dir 2775 news news</literal></screen>
187
188 <para><application>Leafnode</application> may be configured to
189 use <command>inetd</command> by adding an entry to the
190 <filename>/etc/inetd.conf</filename> file with the following
191 command:</para>
192
193<screen role="root"><userinput>echo "nntp stream tcp nowait news /usr/sbin/tcpd /usr/sbin/leafnode" \
194&gt;&gt; /etc/inetd.conf</userinput></screen>
195
196 <para>Issue a <command>killall -HUP inetd</command> to reread the
197 changed <filename>inetd.conf</filename> file.</para>
198<!--
199 <para>If you use <command>xinetd</command>, the following command will
200 create the <application>Leafnode</application> file as
201 <filename>/etc/xinetd.d/nntp</filename>:</para>
202
203<screen role="root"><userinput>cat &gt;&gt; /etc/xinetd.d/nntp &lt;&lt; "EOF"
204<literal># Begin /etc/xinetd.d/nntp
205
206 service nntp
207 {
208 flags = NAMEINARGS NOLIBWRAP
209 socket_type = stream
210 protocol = tcp
211 wait = no
212 user = news
213 server = /usr/sbin/tcpd
214 server_args = /usr/sbin/leafnode
215 instances = 7
216 per_source = 3
217 }
218
219# End /etc/xinetd.d/nntp</literal>
220EOF</userinput></screen>
221
222 <para>Issue a <command>killall -HUP xinetd</command> to reread the
223 changed <filename>xinetd.conf</filename> file.</para>
224-->
225 <para>Add entries to the <systemitem class="username">root</systemitem>
226 or <systemitem class="username">news</systemitem> user's crontab to run
227 the <command>fetchnews</command> and <command>texpire</command> commands
228 at the desired time intervals.</para>
229
230 </sect3>
231
232 </sect2>
233
234 <sect2 role="content">
235 <title>Contents</title>
236
237 <segmentedlist>
238 <segtitle>Installed Programs</segtitle>
239 <segtitle>Installed Libraries</segtitle>
240 <segtitle>Installed Directories</segtitle>
241
242 <seglistitem>
243 <seg>applyfilter, checkgroups, fetchnews, leafnode,
244 leafnode-version, newsq, and texpire</seg>
245 <seg>None</seg>
246 <seg>/etc/leafnode, /var/lock/leafnode, and /var/spool/news</seg>
247 </seglistitem>
248 </segmentedlist>
249
250 <variablelist>
251 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
252 <?dbfo list-presentation="list"?>
253 <?dbhtml list-presentation="table"?>
254
255 <varlistentry id="applyfilter">
256 <term><command>applyfilter</command></term>
257 <listitem>
258 <para>filters newsgroup articles according to regular
259 expressions.</para>
260 <indexterm zone="leafnode applyfilter">
261 <primary sortas="b-applyfilter">applyfilter</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="checkgroups">
267 <term><command>checkgroups</command></term>
268 <listitem>
269 <para>inserts newsgroup titles into the newsgroup database.</para>
270 <indexterm zone="leafnode checkgroups">
271 <primary sortas="b-checkgroups">checkgroups</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="fetchnews">
277 <term><command>fetchnews</command></term>
278 <listitem>
279 <para>sends posted articles to and retrieves new articles from an
280 upstream news server.</para>
281 <indexterm zone="leafnode fetchnews">
282 <primary sortas="b-fetchnews">fetchnews</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="leafnode-prog">
288 <term><command>leafnode</command></term>
289 <listitem>
290 <para>is an NNTP server daemon.</para>
291 <indexterm zone="leafnode leafnode-prog">
292 <primary sortas="b-leafnode">leafnode</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="leafnode-version">
298 <term><command>leafnode-version</command></term>
299 <listitem>
300 <para>prints the <application>Leafnode</application> version.</para>
301 <indexterm zone="leafnode leafnode-version">
302 <primary sortas="b-leafnode-version">leafnode-version</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="newsq">
308 <term><command>newsq</command></term>
309 <listitem>
310 <para>shows articles waiting to be sent upstream.</para>
311 <indexterm zone="leafnode newsq">
312 <primary sortas="b-newsq">newsq</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="texpire">
318 <term><command>texpire</command></term>
319 <listitem>
320 <para>expires old articles and unread groups.</para>
321 <indexterm zone="leafnode texpire">
322 <primary sortas="b-texpire">texpire</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 </variablelist>
328
329 </sect2>
330
331</sect1>
Note: See TracBrowser for help on using the repository browser.