summaryrefslogtreecommitdiff
path: root/doc/imrelp.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/imrelp.html')
-rw-r--r--doc/imrelp.html84
1 files changed, 0 insertions, 84 deletions
diff --git a/doc/imrelp.html b/doc/imrelp.html
deleted file mode 100644
index 9f3e487..0000000
--- a/doc/imrelp.html
+++ /dev/null
@@ -1,84 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head>
-<meta http-equiv="Content-Language" content="en"><title>RELP Input Module</title>
-
-</head>
-<body>
-<a href="rsyslog_conf_modules.html">back</a>
-
-<h1>RELP Input Module</h1>
-<p><b>Module Name:&nbsp;&nbsp;&nbsp; imrelp</b></p>
-<p><b>Author: Rainer Gerhards</b></p>
-<p><b>Description</b>:</p>
-<p>Provides the ability to receive syslog messages via the
-reliable RELP protocol. This module requires <a href="http://www.librelp.com">librelp</a> to be
-present on the system. From the user's point of view, imrelp works much
-like imtcp or imgssapi, except that no message loss can occur. Please
-note that with the currently supported relp protocol version, a minor
-message duplication may occur if a network connection between the relp
-client and relp server breaks after the client could successfully send
-some messages but the server could not acknowledge them. The window of
-opportunity is very slim, but in theory this is possible. Future
-versions of RELP will prevent this. Please also note that rsyslogd may
-lose a few messages if rsyslog is shutdown while a network conneciton
-to the server is broken and could not yet be recovered. Future version
-of RELP support in rsyslog will prevent that. Please note that both
-scenarios also exists with plain tcp syslog. RELP, even with the small
-nits outlined above, is a much more reliable solution than plain tcp
-syslog and so it is highly suggested to use RELP instead of plain tcp.
-Clients send messages to the RELP server via omrelp.</p>
-
-<p><b>Configuration Directives</b>:</p>
-<ul>
-<li><b>Ruleset</b> &lt;name&gt;</br>
-Binds the specified ruleset to all RELP listeners.
-<li><b>Port</b> &lt;port&gt;<br>
-Starts a RELP server on selected port</li>
-</ul>
-<b>Caveats/Known Bugs:</b>
-<ul>
-<li>see description</li>
-<li>To obtain the remote system's IP address, you need to have at least
-librelp 1.0.0 installed. Versions below it return the hostname instead
-of the IP address.</li>
-<li>Contrary to other inputs, the ruleset can only be bound to all listeners,
-not specific ones. This is due to a currently existing limitation in librelp.
-</ul>
-<p><b>Sample:</b></p>
-<p>This sets up a RELP server on port 20514.<br>
-</p>
-<textarea rows="15" cols="60">module(load="imrelp") # needs to be done just once
-input(type="imrelp" port="20514")
-</textarea>
-
-<p><b>Legacy Configuration Directives</b>:</p>
-<ul>
-<li>InputRELPServerBindRuleset &lt;name&gt; (available in 6.3.6+)</br>
-equivalent to: RuleSet
-<li>InputRELPServerRun &lt;port&gt;<br>
-equivalent to: Port</li>
-</ul>
-<b>Caveats/Known Bugs:</b>
-<ul>
-<li>see description</li>
-<li>To obtain the remote system's IP address, you need to have at least
-librelp 1.0.0 installed. Versions below it return the hostname instead
-of the IP address.</li>
-<li>Contrary to other inputs, the ruleset can only be bound to all listeners,
-not specific ones. This is due to a currently existing limitation in librelp.
-</ul>
-<p><b>Sample:</b></p>
-<p>This sets up a RELP server on port 20514.<br>
-</p>
-<textarea rows="15" cols="60">$ModLoad imrelp # needs to be done just once
-$InputRELPServerRun 20514
-</textarea>
-<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>]
-[<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-2011 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 3 or higher.</font></p>
-</body></html>