More document munging

git-svn-id: https://shorewall.svn.sourceforge.net/svnroot/shorewall/trunk@6736 fbd18981-670d-0410-9b5c-8dc0c1a9a2bb
This commit is contained in:
teastep 2007-07-01 17:02:22 +00:00
parent 0b2cdd5794
commit 0d7c482e60
2 changed files with 94 additions and 76 deletions

View File

@ -94,24 +94,24 @@
work.<note>
<para>If you are installing Shorewall 4.0.0 or later then you need
to install at least two packages.<itemizedlist>
<listitem>
<para>Shorewall</para>
</listitem>
<listitem>
<para>Either Shorewall-shell (the classic shell-based
configuration compiler) and/or Shorewall-perl (the newer and
faster compiler written in Perl).</para>
</listitem>
<listitem>
<para>Shorewall-common</para>
</listitem>
</itemizedlist>If you are installing Shorewall for the first
time, we strongly suggest that you install Shorewall-perl.</para>
</note></para>
</listitem>
<listitem>
<para>Install the RPM</para>
<para>Install the RPMs</para>
<programlisting><command>rpm -ivh &lt;shorewall rpm&gt; &lt;compiler rpm&gt; ...</command></programlisting>
<programlisting><command>rpm -ivh &lt;compiler rpm&gt; ... &lt;shorewall-common rpm&gt;</command></programlisting>
<caution>
<para>Some users are in the habit of using the <command>rpm
@ -145,6 +145,8 @@
<programlisting><command>rpm -ivh --nodeps &lt;rpms&gt;</command></programlisting>
</note>
<para>Example:<programlisting><command>rpm -ivh shorewall-perl-4.0.0-1.noarch.rpm shorewall-common-4.0.0-1.noarch.rpm</command></programlisting></para>
</listitem>
<listitem>
@ -180,52 +182,45 @@
<title>Install using tarball</title>
<note>
<para>If you are installing Shorewall 4.0.0 or later, then you need to
install one of the configuration compilers <emphasis
role="bold">before</emphasis> you install Shorewall itself. You can
choose to install one or both compilers:<itemizedlist>
<para>If you are installing Shorewall 4.0.0 or later then you need to
install at least two packages.<itemizedlist>
<listitem>
<para>Shorewall-shell - the classic configuration compiler written
in Bourne Shell.</para>
<para>Either Shorewall-shell (the classic shell-based
configuration compiler) and/or Shorewall-perl (the newer and
faster compiler written in Perl).</para>
</listitem>
<listitem>
<para>Shorewall-perl - a newer and faster compiler written in
Perl.</para>
<para>Shorewall-common</para>
</listitem>
</itemizedlist>If you are installing Shorewall for the first time, we
strongly suggest that you install Shorewall-perl.</para>
<para>To install Shorewall-perl:<orderedlist>
<listitem>
<para>unpack the tarball (tar -zxf
shorewall-perl-x.y.z.tgz).</para>
</listitem>
<listitem>
<para>cd to the shorewall-perl directory (the version is encoded
in the directory name as in
<quote>shorewall-perl-4.0.0</quote>).</para>
</listitem>
<listitem>
<para>Type:</para>
<programlisting><command>./install.sh</command></programlisting>
</listitem>
</orderedlist>Installing Shorewall-shell is similar.</para>
</note>
<para>To install Shorewall using the tarball and install script:</para>
<para>To install Shorewall-perl and Shorewall-common using the tarball and
install scripts:</para>
<orderedlist>
<listitem>
<para>unpack the tarball (tar -zxf shorewall-x.y.z.tgz).</para>
<para>unpack the tarballs:<programlisting><command>tar -jxf shorewall-common-4.0.0.tar.bz2</command>
<command>tar -jxf shorewall-perl-4.0.0.tar.bz2
</command></programlisting></para>
</listitem>
<listitem>
<para>cd to the shorewall directory (the version is encoded in the
directory name as in <quote>shorewall-3.2.1</quote>).</para>
<para>cd to the shorewall-perl directory (the version is encoded in
the directory name as in <quote>shorewall-perl-4.0.0</quote>).</para>
</listitem>
<listitem>
<para>Type:</para>
<programlisting><command>./install.sh</command></programlisting>
</listitem>
<listitem>
<para>cd to the shorewall-common directory (the version is encoded in
the directory name as in <quote>shorewall-perl-4.0.0</quote>)</para>
</listitem>
<listitem>
@ -260,25 +255,13 @@
</orderedlist>
</section>
<section id="LRP">
<title>Install the .lrp</title>
<para>To install my version of Shorewall on a fresh Bering disk, simply
replace the <quote>shorwall.lrp</quote> file on the image with the file
that you downloaded. For example, if you download
<filename>shorewall-lrp-2.2.0.tgz</filename> then you will rename the file
to <filename>shorwall.lrp</filename> and replace the file by that name on
the Bering disk with the new file. Then proceed to configure Shorewall as
described in the Bering (or Bering uClibc) documentation.</para>
</section>
<section id="Debian">
<title>Install the .deb</title>
<important>
<para>Once you have installed the .deb package and before you attempt to
configure Shorewall, please heed the advice of Lorenzo Martignoni, the
Shorewall Debian Maintainer:</para>
<para>Once you have installed the .deb packages and before you attempt
to configure Shorewall, please heed the advice of Lorenzo Martignoni,
the Shorewall Debian Maintainer:</para>
<para><quote>For more information about Shorewall usage on Debian system
please look at /usr/share/doc/shorewall/README.Debian provided by [the]
@ -369,7 +352,7 @@ Pin-Priority: 700</programlisting><emphasis role="bold"><emphasis>Then
<listitem>
<para>Upgrade the RPM</para>
<programlisting><command>rpm -Uvh &lt;shorewall-common rpm file&gt; &lt;compiler rpm file&gt; ...</command></programlisting>
<programlisting><command>rpm -Uvh &lt;compiler rpm file&gt; ... &lt;shorewall-common rpm file&gt; </command></programlisting>
<note>
<para>Some <trademark>SUSE</trademark> users have encountered a
@ -424,14 +407,30 @@ Pin-Priority: 700</programlisting><emphasis role="bold"><emphasis>Then
<orderedlist>
<listitem>
<para>unpack the tarball.</para>
<programlisting><command>tar -zxf shorewall-x.y.z.tgz</command></programlisting>
<para>unpack the tarballs:<programlisting><command>tar -jxf shorewall-common-4.0.0.tar.bz2</command>
<command>tar -jxf shorewall-perl-4.0.0.tar.bz2
tar -jxf shorewall-shell-4.0.0.tar.bz2</command> (if you use this compiler)</programlisting></para>
</listitem>
<listitem>
<para>cd to the shorewall directory (the version is encoded in the
directory name as in <quote>shorewall-3.2.1</quote>).</para>
<para>cd to the shorewall-perl directory (the version is encoded in
the directory name as in <quote>shorewall-perl-4.0.0</quote>).</para>
</listitem>
<listitem>
<para>Type:</para>
<programlisting><command>./install.sh</command></programlisting>
</listitem>
<listitem>
<para>Perform the above two steps for the shorewall-shell directory if
you use that compiler.</para>
</listitem>
<listitem>
<para>cd to the shorewall-common directory (the version is encoded in
the directory name as in <quote>shorewall-perl-4.0.0</quote>)</para>
</listitem>
<listitem>

View File

@ -56,39 +56,57 @@ download from the Download Sites listed in the table below.</p>
<p><font color="#ff0000"><b>NOTICE: There are two current Shorewall Release
Series:</b></font></p>
<ul>
<li><p style="margin-bottom: 0in;">The STABLE release series is 3.4. Choose
<li><p style="margin-bottom: 0in;">The STABLE release series is 4.0. Choose
this release if you value stability and good documentation.</p>
</li>
<li><p>The DEVELOPMENT release series is 3.9 (found in the 'development'
<li><p>The DEVELOPMENT release series is 4.1 (found in the 'development'
directory). Choose this release if you are <strong>very
experienced</strong> <strong>user</strong> and you are willing to help
and report bugs. <strong>THIS VERSION IS EXPERIMENTAL AND IS NOT
SUPPORTED.</strong> </p>
test the code and report bugs. <strong>THIS VERSION IS EXPERIMENTAL AND
IS NOT SUPPORTED.</strong> </p>
</li>
</ul>
<p>For additional information, see this article about the <a
href="ReleaseModel.html">Shorewall Release Model</a>. </p>
<p>Beginning with Shorewall version 3.2.0 RC1, there are two related
products:<br>
</p>
<p>Beginning with Shorewall version 4.0.0 RC1, there are four related
packages:</p>
<ul>
<li>Shorewall -- the full Shorewall package. You must have this installed
on at least one system within your network.<br>
</li>
<li>Shorewall-shell -- the legacy Shorewall configuration compiler written
in Bourne Shell.</li>
<li>Shorewall-perl -- an implementation of the Shorewall configuration
compiler written in the Perl programming language. This compiler is much
faster than Shorewall-shell and produces a firewall script that runs
faster. It is the preferred compiler for new Shorewall installations.</li>
<li>Shorewall-common -- A base package required by both Shorewall-shell and
Shorewall-perl.</li>
<li>Shorewall Lite -- a light-weight Shorewall version that will run
compiled firewall scripts generated on a system with the full package
installed.</li>
compiled firewall scripts generated on a system with one of the compiler
packages installed.</li>
</ul>
<span style="font-weight: bold;">You probably don't want to install both
Shorewall and Shorewall Lite on the same system. See the <a
To summarize:
<ul>
<li>On at least one system in your network, you must install one or both of
the compilers (Shorewall-shell and/or Shorewall-perl) and the
Shorewall-common package.</li>
<li>If you only have a single firewall, then that system should be your
firewall system.</li>
<li>If you have more than one firewall, you may wish to install one or both
of the compilers on a single <em>administrative</em> system and install
Shorewall-lite on the firewalls. Doing so will allow for centralized
administration and configuration of the firewalls.</li>
</ul>
<p><br>
<span style="font-weight: bold;">You probably don't want to install both a
Shorewall compiler and Shorewall Lite on the same system. See the <a
href="CompiledPrograms.html#Lite">Shorewall Lite Documentation</a> for
details.</span><br>
</p>
<p>Once you've printed the appropriate QuickStart Guide, download <u>one</u>
of the modules:</p>
<p>Once you've printed the appropriate QuickStart Guide, download the
appropriate modules:</p>
<ul>
<li><p style="margin-bottom: 0in;">Simon Matter provides RPMs tailored for
<b>Redhat</b> and <b>Fedora</b>. You can <a
@ -405,7 +423,8 @@ href="https://lists.shorewall.net/shorewall.gpg.key">https://lists.shorewall.net
<br>
You should download and use the latest SVN version only <b>at your own
risk</b> -- please do not attempt to install Shorewall from the SVN
components; you will end up with an incomplete and non-working installation.
components; you will end up with an incomplete and non-working
installation.
<p>If you are looking for bug fixes for the current release, see <a
href="#Updates">above.</a><br>