1 files changed, 56 insertions, 0 deletions

diff --git a/plugins/omrabbitmq/README.md b/plugins/omrabbitmq/README.md
new file mode 100644
index 00000000..7aa60206
--- /dev/null
+++ b/plugins/omrabbitmq/README.md
@@ -0,0 +1,56 @@
+
+# rsyslog output module for RabbitMQ
+
+This module sends syslog messages into RabbitMQ server.
+
+Only v6 configuration syntax is supported.
+
+**omrabbitmq is tested only with 6.6.0 version of rsyslog.**
+
+
+## Compile
+To successfully compile omrabbitmq module you need [rabbitmq-c](https://github.com/alanxz/rabbitmq-c) library.
+
+    ./configure --enable-omrabbitmq ...
+
+
+----
+## Configure
+
+omrabbitmq output module supports only v6 configuration syntax.
+
+Parameters:
+
+* host=<hostname> – server
+* virtual_host=<virtual\_host> – virtual  message  broker
+* user=<user> – user name
+* password=<password> – password
+* exchange=<name> – exchange name
+* routing_key=<name> – name of routing key
+
+
+Example:
+
+        $ModLoad omrabbitmq
+
+        *.*    action(type="omrabbitmq" 
+                 host="localhost"
+                 virtual_host="/"
+                 user="guest"
+                 password="guest"
+                 exchange="syslog"
+                 routing_key="syslog.all"
+                 template="RSYSLOG_ForwardFormat"
+                 queue.type="linkedlist"
+                 queue.timeoutenqueue="0"
+                 queue.filename="rabbitmq"
+                 queue.highwatermark="500000"
+                 queue.lowwatermark="400000"
+                 queue.discardmark="5000000"
+                 queue.timeoutenqueue="0"
+                 queue.maxdiskspace="5g"
+                 queue.size="2000000"
+                 queue.saveonshutdown="on"
+                 action.resumeretrycount="-1")
+
+