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