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