1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.3/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 " ">
|
---|
9 | <!ENTITY leafnode-size "614 KB">
|
---|
10 | <!ENTITY leafnode-buildsize "14 MB">
|
---|
11 | <!ENTITY leafnode-time "0.11 SBU">
|
---|
12 |
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="leafnode" xreflabel="Leafnode-&leafnode-version;">
|
---|
16 | <?dbhtml filename="leafnode.html"?>
|
---|
17 | <title>Leafnode-&leafnode-version;</title>
|
---|
18 |
|
---|
19 | <sect2>
|
---|
20 | <title>Introduction to <application>Leafnode</application></title>
|
---|
21 |
|
---|
22 | <para><application>Leafnode</application> is an <acronym>NNTP</acronym>
|
---|
23 | server designed for small sites to provide a local USENET spool.</para>
|
---|
24 |
|
---|
25 | <sect3><title>Package information</title>
|
---|
26 | <itemizedlist spacing='compact'>
|
---|
27 | <listitem><para>Download (HTTP): <ulink url="&leafnode-download-http;"/></para></listitem>
|
---|
28 | <listitem><para>Download (FTP): <ulink url="&leafnode-download-ftp;"/></para></listitem>
|
---|
29 | <listitem><para>Download size: &leafnode-size;</para></listitem>
|
---|
30 | <listitem><para>Estimated Disk space required: &leafnode-buildsize;</para></listitem>
|
---|
31 | <listitem><para>Estimated build time: &leafnode-time;</para></listitem></itemizedlist>
|
---|
32 | </sect3>
|
---|
33 |
|
---|
34 | <sect3><title><application>Leafnode</application> dependencies</title>
|
---|
35 | <sect4><title>Required</title>
|
---|
36 | <para><xref linkend="pcre"/> and <xref linkend="tcpwrappers"/>
|
---|
37 | </para></sect4>
|
---|
38 | </sect3>
|
---|
39 |
|
---|
40 | </sect2>
|
---|
41 |
|
---|
42 | <sect2>
|
---|
43 | <title>Installation of <application>Leafnode</application></title>
|
---|
44 |
|
---|
45 | <para>Create the group and user news, if not present:</para>
|
---|
46 |
|
---|
47 | <screen><userinput><command>groupadd news &&
|
---|
48 | useradd -g news news</command></userinput></screen>
|
---|
49 |
|
---|
50 | <para>Install <application>Leafnode</application> by running the following
|
---|
51 | commands:</para>
|
---|
52 |
|
---|
53 | <screen><userinput><command>./configure --prefix=/usr --localstatedir=/var \
|
---|
54 | --sysconfdir=/etc/news --with-lockfile=/var/lock/fetchnews.lck &&
|
---|
55 | make &&
|
---|
56 | make install &&
|
---|
57 | ldconfig &&
|
---|
58 | make update</command></userinput></screen>
|
---|
59 |
|
---|
60 | </sect2>
|
---|
61 |
|
---|
62 | <sect2>
|
---|
63 | <title>Installation command explanations</title>
|
---|
64 |
|
---|
65 | <para><parameter>--localstatedir=/var</parameter>: Change the default
|
---|
66 | spool directory of <filename class="directory">/usr/var</filename>.</para>
|
---|
67 |
|
---|
68 | <para><parameter>--sysconfdir=/etc/news</parameter>: leafnode reads its
|
---|
69 | configuration data from a file called <filename>config</filename> which
|
---|
70 | will be created in <filename class="directory">/etc/news</filename> to
|
---|
71 | avoid any potential conflict with other packages.</para>
|
---|
72 |
|
---|
73 | <para><command>make update</command>: Create an initial
|
---|
74 | <filename>/etc/news/config.example</filename> file, which must be
|
---|
75 | renamed to <filename>/etc/news/config</filename>.</para>
|
---|
76 |
|
---|
77 | </sect2>
|
---|
78 |
|
---|
79 | <sect2>
|
---|
80 | <title>Configuring <application>Leafnode</application></title>
|
---|
81 |
|
---|
82 | <sect3><title>Config files</title>
|
---|
83 | <para><filename>/etc/news/config</filename>,
|
---|
84 | <filename>/etc/inetd.conf</filename> or
|
---|
85 | <filename>/etc/xinetd.conf</filename></para>
|
---|
86 |
|
---|
87 | <para><application>Leafnode</application> may be configured to use
|
---|
88 | <command>inetd</command> by adding an entry
|
---|
89 | to the <filename>/etc/inetd.conf</filename> file with the following
|
---|
90 | command:</para>
|
---|
91 |
|
---|
92 | <screen><userinput><command>echo "nntp stream tcp nowait news /usr/sbin/tcpd /usr/sbin/leafnode" \
|
---|
93 | >> /etc/inetd.conf</command></userinput></screen>
|
---|
94 |
|
---|
95 | <para>Issue a <command>killall -HUP inetd</command> to reread the
|
---|
96 | changed <filename>inetd.conf</filename> file.</para>
|
---|
97 |
|
---|
98 | <para>Alternatively, <application>Leafnode</application> may be configured to
|
---|
99 | use <command>xinetd</command> by adding an entry to the <filename>
|
---|
100 | /etc/xinetd.conf</filename> file with the following command:</para>
|
---|
101 |
|
---|
102 | <screen><userinput><command>cat >> /etc/xinetd.conf << "EOF" </command>
|
---|
103 | service nntp
|
---|
104 | {
|
---|
105 | flags = NAMEINARGS NOLIBWRAP
|
---|
106 | socket_type = stream
|
---|
107 | protocol = tcp
|
---|
108 | wait = no
|
---|
109 | user = news
|
---|
110 | server = /usr/sbin/tcpd
|
---|
111 | server_args = /usr/sbin/leafnode
|
---|
112 | instances = 7
|
---|
113 | per_source = 3
|
---|
114 | }
|
---|
115 | <command>EOF</command></userinput></screen>
|
---|
116 |
|
---|
117 | <para>Issue a <command>killall -HUP xinetd</command> to reread the
|
---|
118 | changed <filename>xinetd.conf</filename> file.</para>
|
---|
119 |
|
---|
120 | <para>The <filename>/etc/news/config</filename> file must be
|
---|
121 | edited to reflect the name of the upstream <acronym>NNTP</acronym>
|
---|
122 | provider. Copy the
|
---|
123 | example configuration file to <filename>/etc/news/config</filename>
|
---|
124 | and save the original for reference: </para>
|
---|
125 |
|
---|
126 | <screen><userinput><command>cp /etc/news/config.example /etc/news/config
|
---|
127 | </command></userinput></screen>
|
---|
128 |
|
---|
129 | <para>Change the
|
---|
130 | <screen><userinput>server = </userinput></screen>
|
---|
131 | entry to reflect your news provider.</para>
|
---|
132 |
|
---|
133 | <para>The <envar>NNTPSERVER</envar> environment variable must be set to
|
---|
134 | 127.0.0.1 to prevent news clients from reading news from the upstream feed,
|
---|
135 | so add the following to <filename>/etc/profile</filename> or
|
---|
136 | <filename>$HOME/.bash_profile</filename>:</para>
|
---|
137 |
|
---|
138 | <screen><userinput><command>export NNTPSERVER=127.0.0.1</command></userinput></screen>
|
---|
139 |
|
---|
140 | </sect3>
|
---|
141 |
|
---|
142 | </sect2>
|
---|
143 |
|
---|
144 | <sect2>
|
---|
145 | <title>Contents</title>
|
---|
146 |
|
---|
147 | <para>The <application>Leafnode</application> package contains
|
---|
148 | <command>leafnode-version</command>,
|
---|
149 | <command>leafnode</command>,
|
---|
150 | <command>applyfilter</command>,
|
---|
151 | <command>texpire</command>,
|
---|
152 | <command>checkgroups</command>,
|
---|
153 | <command>fetchnews</command> and
|
---|
154 | <command>newsq.</command></para></sect2>
|
---|
155 |
|
---|
156 | <sect2><title>Description</title>
|
---|
157 |
|
---|
158 | <sect3><title>leafnode-version</title>
|
---|
159 | <para><command>leafnode-version</command> prints the leafnode
|
---|
160 | version.</para></sect3>
|
---|
161 |
|
---|
162 | <sect3><title>leafnode</title>
|
---|
163 | <para><command>leafnode</command> is the <acronym>NNTP</acronym> server daemon.</para></sect3>
|
---|
164 |
|
---|
165 | <sect3><title>applyfilter</title>
|
---|
166 | <para><command>applyfilter</command> filters newsgroup articles according to regular
|
---|
167 | expressions.</para></sect3>
|
---|
168 |
|
---|
169 | <sect3><title>texpire</title>
|
---|
170 | <para><command>texpire</command> expires old articles and unread groups.</para></sect3>
|
---|
171 |
|
---|
172 | <sect3><title>checkgroups</title>
|
---|
173 | <para><command>checkgroups</command> inserts newsgroup titles into the newsgroup
|
---|
174 | database.</para></sect3>
|
---|
175 |
|
---|
176 | <sect3><title>fetchnews</title>
|
---|
177 | <para><command>fetchnews</command> sends posted articles to and retrieves new articles
|
---|
178 | from an upstream news server.</para></sect3>
|
---|
179 |
|
---|
180 | <sect3><title>newsq</title>
|
---|
181 | <para><command>newsq</command> shows articles waiting to be sent upstream.</para></sect3>
|
---|
182 |
|
---|
183 | </sect2>
|
---|
184 |
|
---|
185 | </sect1>
|
---|
186 |
|
---|