source: archive/leafnode.xml@ 4e48de46

10.0 10.1 11.0 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 4e48de46 was 4e48de46, checked in by Bruce Dubbs <bdubbs@…>, 9 years ago

Cleanup V. Servers

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@10191 af4574ff-66df-0310-9fd7-8a98e5e911e0

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