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