diff options
Diffstat (limited to 'doc/imrelp.html')
| -rw-r--r-- | doc/imrelp.html | 28 |
1 files changed, 26 insertions, 2 deletions
diff --git a/doc/imrelp.html b/doc/imrelp.html index d83b2a15..80ddfd53 100644 --- a/doc/imrelp.html +++ b/doc/imrelp.html @@ -27,11 +27,12 @@ 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>InputRELPServerBindRuleset <name> (available in 6.3.6+)</br> +<li><b>Ruleset</b> <name> (available in 6.3.6+)</br> Binds the specified ruleset to all RELP listeners. -<li>InputRELPServerRun <port><br> +<li><b>Port</b> <port><br> Starts a RELP server on selected port</li> </ul> <b>Caveats/Known Bugs:</b> @@ -46,6 +47,29 @@ not specific ones. This is due to a currently existing limitation in librelp. <p><b>Sample:</b></p> <p>This sets up a RELP server on port 20514.<br> </p> +<textarea rows="15" cols="60">module(load="/folder/to/rsyslog/plugins/imrelp/.libs/imrelp") # needs to be done just once +input(type="imrelp" port="20514") +</textarea> + +<p><b>Legacy Configuration Directives</b>:</p> +<ul> +<li>InputRELPServerBindRuleset <name> (available in 6.3.6+)</br> +equivalent to: RuleSet +<li>InputRELPServerRun <port><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> |