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