[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">
|
---|
| 9 | <!ENTITY leafnode-size "383 KB">
|
---|
| 10 | <!ENTITY leafnode-buildsize "8.8 MB">
|
---|
[0931098] | 11 | <!ENTITY leafnode-time "0.11 SBU">
|
---|
| 12 |
|
---|
| 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>
|
---|
[f45b1953] | 22 |
|
---|
[0931098] | 23 | <sect2>
|
---|
| 24 | <title>Introduction to <application>Leafnode</application></title>
|
---|
| 25 |
|
---|
| 26 | <para><application>Leafnode</application> is an <acronym>NNTP</acronym>
|
---|
| 27 | server designed for small sites to provide a local USENET spool.</para>
|
---|
| 28 |
|
---|
| 29 | <sect3><title>Package information</title>
|
---|
| 30 | <itemizedlist spacing='compact'>
|
---|
| 31 | <listitem><para>Download (HTTP): <ulink url="&leafnode-download-http;"/></para></listitem>
|
---|
| 32 | <listitem><para>Download (FTP): <ulink url="&leafnode-download-ftp;"/></para></listitem>
|
---|
| 33 | <listitem><para>Download size: &leafnode-size;</para></listitem>
|
---|
[518538f] | 34 | <listitem><para>Estimated disk space required: &leafnode-buildsize;</para></listitem>
|
---|
[0931098] | 35 | <listitem><para>Estimated build time: &leafnode-time;</para></listitem></itemizedlist>
|
---|
| 36 | </sect3>
|
---|
| 37 |
|
---|
| 38 | <sect3><title><application>Leafnode</application> dependencies</title>
|
---|
| 39 | <sect4><title>Required</title>
|
---|
| 40 | <para><xref linkend="pcre"/> and <xref linkend="tcpwrappers"/>
|
---|
| 41 | </para></sect4>
|
---|
[9f729d3] | 42 | <sect4><title>Recommended</title>
|
---|
| 43 | <para><xref linkend="xinetd"/></para></sect4>
|
---|
[0931098] | 44 | </sect3>
|
---|
| 45 |
|
---|
| 46 | </sect2>
|
---|
| 47 |
|
---|
| 48 | <sect2>
|
---|
| 49 | <title>Installation of <application>Leafnode</application></title>
|
---|
| 50 |
|
---|
| 51 | <para>Create the group and user news, if not present:</para>
|
---|
| 52 |
|
---|
| 53 | <screen><userinput><command>groupadd news &&
|
---|
| 54 | useradd -g news news</command></userinput></screen>
|
---|
| 55 |
|
---|
| 56 | <para>Install <application>Leafnode</application> by running the following
|
---|
| 57 | commands:</para>
|
---|
| 58 |
|
---|
[9f729d3] | 59 | <screen><userinput><command>./configure --prefix=/usr \
|
---|
| 60 | --localstatedir=/var --sysconfdir=/etc/leafnode \
|
---|
| 61 | --with-lockfile=/var/lock/leafnode/fetchnews.lck &&
|
---|
[0931098] | 62 | make &&
|
---|
[9f729d3] | 63 | make install</command></userinput></screen>
|
---|
| 64 | <!-- ldconfig && -->
|
---|
| 65 | <!-- make update</command></userinput></screen> -->
|
---|
[0931098] | 66 |
|
---|
| 67 | </sect2>
|
---|
| 68 |
|
---|
| 69 | <sect2>
|
---|
| 70 | <title>Installation command explanations</title>
|
---|
| 71 |
|
---|
| 72 | <para><parameter>--localstatedir=/var</parameter>: Change the default
|
---|
| 73 | spool directory of <filename class="directory">/usr/var</filename>.</para>
|
---|
| 74 |
|
---|
[9f729d3] | 75 | <para><parameter>--sysconfdir=/etc/leafnode</parameter>:
|
---|
| 76 | <application>Leafnode</application> reads its configuration data from a file
|
---|
| 77 | called <filename>config</filename> which will be created in
|
---|
| 78 | <filename class="directory">/etc/leafnode</filename> to
|
---|
[0931098] | 79 | avoid any potential conflict with other packages.</para>
|
---|
| 80 |
|
---|
[9f729d3] | 81 | <para><command>make update</command>: Run this command if you are upgrading
|
---|
| 82 | from a very old version of <application>Leafnode</application>.</para>
|
---|
[0931098] | 83 |
|
---|
| 84 | </sect2>
|
---|
| 85 |
|
---|
| 86 | <sect2>
|
---|
| 87 | <title>Configuring <application>Leafnode</application></title>
|
---|
| 88 |
|
---|
| 89 | <sect3><title>Config files</title>
|
---|
[9f729d3] | 90 | <para><filename>/etc/leafnode/config</filename>,
|
---|
| 91 | <filename>/etc/xinetd.conf</filename> or
|
---|
| 92 | <filename>/etc/inetd.conf</filename></para></sect3>
|
---|
| 93 |
|
---|
| 94 | <sect3><title>Configuration commands</title>
|
---|
| 95 |
|
---|
| 96 | <para>The <filename>/etc/leafnode/config</filename> file must be
|
---|
| 97 | edited to reflect the name of the upstream <acronym>NNTP</acronym>
|
---|
| 98 | provider. Copy the example configuration file to
|
---|
| 99 | <filename>/etc/leafnode/config</filename> and save the original for
|
---|
| 100 | reference:</para>
|
---|
| 101 |
|
---|
| 102 | <screen><userinput><command>cp /etc/leafnode/config.example /etc/leafnode/config</command></userinput></screen>
|
---|
| 103 |
|
---|
| 104 | <para>Change the
|
---|
| 105 | <screen><userinput>server = </userinput></screen>
|
---|
| 106 | entry to reflect your news provider.</para>
|
---|
| 107 |
|
---|
| 108 | <para>The <filename>/etc/nntpserver</filename> file must contain 127.0.0.1 to
|
---|
| 109 | prevent news clients from reading news from the upstream feed. Create this
|
---|
| 110 | file using the following command:</para>
|
---|
| 111 |
|
---|
| 112 | <screen><userinput><command>cat > /etc/nntpserver << "EOF"</command>
|
---|
| 113 | 127.0.0.1
|
---|
| 114 | <command>EOF</command></userinput></screen>
|
---|
| 115 |
|
---|
| 116 | <para>The <command>/etc/rc.d/init.d/cleanfs</command> script, part of the
|
---|
| 117 | <acronym>LFS</acronym> bootscript package, will remove the
|
---|
| 118 | <filename class="directory">/var/lock/leafnode</filename> directory during
|
---|
| 119 | the system boot sequence. Install the following line in the
|
---|
| 120 | <filename>/etc/sysconfig/createfiles</filename> file to re-create the
|
---|
| 121 | directory:</para>
|
---|
| 122 |
|
---|
| 123 | <screen><userinput>/var/lock/leafnode dir 2775 news news</userinput></screen>
|
---|
[0931098] | 124 |
|
---|
| 125 | <para><application>Leafnode</application> may be configured to use
|
---|
[9f729d3] | 126 | <command>inetd</command> by adding an entry to the
|
---|
| 127 | <filename>/etc/inetd.conf</filename> file with the following
|
---|
[0931098] | 128 | command:</para>
|
---|
| 129 |
|
---|
| 130 | <screen><userinput><command>echo "nntp stream tcp nowait news /usr/sbin/tcpd /usr/sbin/leafnode" \
|
---|
| 131 | >> /etc/inetd.conf</command></userinput></screen>
|
---|
| 132 |
|
---|
| 133 | <para>Issue a <command>killall -HUP inetd</command> to reread the
|
---|
| 134 | changed <filename>inetd.conf</filename> file.</para>
|
---|
| 135 |
|
---|
| 136 | <para>Alternatively, <application>Leafnode</application> may be configured to
|
---|
[9f729d3] | 137 | use <command>xinetd</command> by adding an entry to the
|
---|
| 138 | <filename>/etc/xinetd.conf</filename> file with the following command:</para>
|
---|
[0931098] | 139 |
|
---|
[9f729d3] | 140 | <screen><userinput><command>cat >> /etc/xinetd.conf << "EOF"</command>
|
---|
[0931098] | 141 | service nntp
|
---|
| 142 | {
|
---|
| 143 | flags = NAMEINARGS NOLIBWRAP
|
---|
| 144 | socket_type = stream
|
---|
| 145 | protocol = tcp
|
---|
| 146 | wait = no
|
---|
| 147 | user = news
|
---|
| 148 | server = /usr/sbin/tcpd
|
---|
| 149 | server_args = /usr/sbin/leafnode
|
---|
| 150 | instances = 7
|
---|
| 151 | per_source = 3
|
---|
| 152 | }
|
---|
| 153 | <command>EOF</command></userinput></screen>
|
---|
| 154 |
|
---|
| 155 | <para>Issue a <command>killall -HUP xinetd</command> to reread the
|
---|
| 156 | changed <filename>xinetd.conf</filename> file.</para>
|
---|
| 157 |
|
---|
[9f729d3] | 158 | <para>Add entries to the root or news user's crontab to run the
|
---|
| 159 | <command>fetchnews</command> and <command>texpire</command> commands at the
|
---|
| 160 | desired time intervals.</para>
|
---|
[0931098] | 161 |
|
---|
| 162 | </sect3>
|
---|
| 163 |
|
---|
| 164 | </sect2>
|
---|
| 165 |
|
---|
| 166 | <sect2>
|
---|
| 167 | <title>Contents</title>
|
---|
| 168 |
|
---|
| 169 | <para>The <application>Leafnode</application> package contains
|
---|
| 170 | <command>leafnode-version</command>,
|
---|
| 171 | <command>leafnode</command>,
|
---|
| 172 | <command>applyfilter</command>,
|
---|
| 173 | <command>texpire</command>,
|
---|
| 174 | <command>checkgroups</command>,
|
---|
| 175 | <command>fetchnews</command> and
|
---|
[9f729d3] | 176 | <command>newsq.</command></para>
|
---|
| 177 | </sect2>
|
---|
[0931098] | 178 |
|
---|
| 179 | <sect2><title>Description</title>
|
---|
| 180 |
|
---|
| 181 | <sect3><title>leafnode-version</title>
|
---|
| 182 | <para><command>leafnode-version</command> prints the leafnode
|
---|
| 183 | version.</para></sect3>
|
---|
| 184 |
|
---|
| 185 | <sect3><title>leafnode</title>
|
---|
[9f729d3] | 186 | <para><command>leafnode</command> is the <acronym>NNTP</acronym>
|
---|
| 187 | server daemon.</para></sect3>
|
---|
[0931098] | 188 |
|
---|
| 189 | <sect3><title>applyfilter</title>
|
---|
[9f729d3] | 190 | <para><command>applyfilter</command> filters newsgroup articles according
|
---|
| 191 | to regular expressions.</para></sect3>
|
---|
[0931098] | 192 |
|
---|
| 193 | <sect3><title>texpire</title>
|
---|
[9f729d3] | 194 | <para><command>texpire</command> expires old articles and unread
|
---|
| 195 | groups.</para></sect3>
|
---|
[0931098] | 196 |
|
---|
| 197 | <sect3><title>checkgroups</title>
|
---|
[9f729d3] | 198 | <para><command>checkgroups</command> inserts newsgroup titles into the
|
---|
| 199 | newsgroup database.</para></sect3>
|
---|
[0931098] | 200 |
|
---|
| 201 | <sect3><title>fetchnews</title>
|
---|
[9f729d3] | 202 | <para><command>fetchnews</command> sends posted articles to and retrieves
|
---|
| 203 | new articles from an upstream news server.</para></sect3>
|
---|
[0931098] | 204 |
|
---|
| 205 | <sect3><title>newsq</title>
|
---|
[9f729d3] | 206 | <para><command>newsq</command> shows articles waiting to be sent
|
---|
| 207 | upstream.</para></sect3>
|
---|
[0931098] | 208 |
|
---|
| 209 | </sect2>
|
---|
[f45b1953] | 210 |
|
---|
| 211 | </sect1>
|
---|