summaryrefslogtreecommitdiffstats
path: root/doc/install.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install.html')
-rw-r--r--doc/install.html34
1 files changed, 29 insertions, 5 deletions
diff --git a/doc/install.html b/doc/install.html
index bee136ce..48b7f649 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -1,5 +1,5 @@
<html><head>
-<title>SSL Encrypting syslog with stunnel</title>
+<title>A guide on HOWTO install rsyslog</title>
<meta name="KEYWORDS" content="syslog encryption, rsyslog, stunnel, secure syslog, tcp, reliable, howto, ssl">
</head>
<body>
@@ -24,7 +24,11 @@ you volunteer to create one, <a href="mailto:rgerhards@adiscon.com">drop me a
line</a>). Thus, this guide focuses on installing from the source, which
thankfully is <b>quite easy</b>.</p>
<h3>Step 1 - Download Software</h3>
-<p>For obvious reasons, you need to download rsyslog. Load the most recent build
+<p>For obvious reasons, you need to download rsyslog. Here, I assume that you
+use a distribution tarball. If you would like to use a version directly from
+the repository, see <a href="build_from_repo.html">build rsyslog from repository</a>
+instead.
+<p>Load the most recent build
from <a href="http://www.rsyslog.com/downloads">http://www.rsyslog.com/downloads</a>.
Extract the software with &quot;tar xzf -nameOfDownloadSet-&quot;. This will create a new
subdirectory rsyslog-version in the current working directory. CD into that. </p>
@@ -53,7 +57,18 @@ the rsyslogd and the man pages to the relevant directories.</p>
<p>In this step, you tell rsyslogd what to do with received messages. If you are
upgrading from stock syslogd, /etc/syslog.conf is probably a good starting
point. Rsyslogd understands stock syslogd syntax, so you can simply copy over
-/etc/syslog.conf to /etc/rsyslog.conf. Then, edit rsyslog.conf for any
+/etc/syslog.conf to /etc/rsyslog.conf. Note since version 3 rsyslog requires
+to load plug-in modules to perform useful work (more about
+<a href="v3compatibility.html">compatibilty notes v3</a>). To load the most common plug-ins,
+add the following to the top of rsyslog.conf:</p>
+<p>
+$ModLoad immark # provides --MARK-- message capability <br />
+$ModLoad imudp # provides UDP syslog reception <br />
+$ModLoad imtcp # provides TCP syslog reception and GSS-API (if compiled to support it) <br />
+$ModLoad imuxsock # provides support for local system logging (e.g. via logger command) <br />
+$ModLoad imklog # provides kernel logging support (previously done by rklogd) <br />
+</p>
+Change rsyslog.conf for any further
enhancements you would like to see. For example, you can add database writing as
outlined in the paper &quot;<a href="rsyslog_mysql.html">Writing syslog Data to MySQL</a>&quot;
(remember you need to enable MySQL support during step 2 if you want to do
@@ -139,9 +154,12 @@ comments or bug sighting reports are very welcome. Please
<li>2007-07-13 *
<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a>&nbsp;
* updated to new autotools-based build system</li>
+ <li>2008-10-01 *
+ <a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a>&nbsp;
+ * added info on building from source repository</li>
</ul>
<h3>Copyright</h3>
-<p>Copyright (c) 2005, 2007
+<p>Copyright &copy; 2005-2008
<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a> and
<a href="http://www.adiscon.com/en/">Adiscon</a>.</p>
<p> Permission is granted to copy, distribute and/or modify this document
@@ -151,6 +169,12 @@ comments or bug sighting reports are very welcome. Please
Texts. A copy of the license can be viewed at
<a href="http://www.gnu.org/copyleft/fdl.html">
http://www.gnu.org/copyleft/fdl.html</a>.</p>
-
+<p>[<a href="manual.html">manual index</a>]
+[<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
+<p><font size="2">This documentation is part of the
+<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
+Copyright &copy; 2008 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
+<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL
+version 1.2 or higher.</font></p>
</body>
</html>