[sr-dev] git:master:e938d587: usrloc_dmq: added readme file

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: e938d587c3d4f1569478a68937bbf9592fae4593
URL: https://github.com/kamailio/kamailio/commit/e938d587c3d4f1569478a68937bbf9592fae4593

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2015-01-03T21:30:34+01:00

usrloc_dmq: added readme file

---

Added: modules/usrloc_dmq/README

---

Diff:  https://github.com/kamailio/kamailio/commit/e938d587c3d4f1569478a68937bbf9592fae4593.diff
Patch: https://github.com/kamailio/kamailio/commit/e938d587c3d4f1569478a68937bbf9592fae4593.patch

---

diff --git a/modules/usrloc_dmq/README b/modules/usrloc_dmq/README
new file mode 100644
index 0000000..3245c07
--- /dev/null
+++ b/modules/usrloc_dmq/README
@@ -0,0 +1,86 @@
+usrloc_dmq Module
+
+Andrey Rybkin
+
+   bks.tv
+   <rybkin.a at bks.tv>
+
+Edited by
+
+Andrey Rybkin
+
+   bks.tv
+   <rybkin.a at bks.tv>
+
+   Copyright © 2014
+     __________________________________________________________________
+
+   Table of Contents
+
+   1. Admin Guide
+
+        1. Overview
+        2. Dependencies
+
+              2.1. Kamailio Modules
+
+        3. Parameters
+
+              3.1. enable (int)
+              3.2. flag (int)
+
+   List of Examples
+
+   1.1. Set flag parameter
+
+Chapter 1. Admin Guide
+
+   Table of Contents
+
+   1. Overview
+   2. Dependencies
+
+        2.1. Kamailio Modules
+
+   3. Parameters
+
+        3.1. enable (int)
+        3.2. flag (int)
+
+1. Overview
+
+   The module add usrloc contacts replication between multiple servers via
+   DMQ module.
+
+2. Dependencies
+
+   2.1. Kamailio Modules
+
+2.1. Kamailio Modules
+
+   The following modules must be loaded before this module:
+     * DMQ module must be loaded first.. USRLOC module must be loaded
+       first..
+
+3. Parameters
+
+   3.1. enable (int)
+   3.2. flag (int)
+
+3.1. enable (int)
+
+   USRLOC replication 0 - disabled 1 - enabled
+
+   Default value is 0.
+
+3.2. flag (int)
+
+   Flag to be used for marking if a contact should be constructed for the
+   DMQ
+
+   Default value is 2.
+
+   Example 1.1. Set flag parameter
+...
+modparam("usrloc_dmq", "flag", 2)
+...