Docs config params started on diameter agent

docs/cgr-engine.rst

@@ -3,9 +3,10 @@
 cgr-engine
 ==========
 
-Groups various services and components.
+Groups most of functionality from services and components.
 
 Customisable through the use of *json* :ref:`configuration <engine_configuration>` or command line arguments (higher prio).
+
 Able to read the configuration from either a local directory  of *.json* files with an unlimited number of subfolders (ordered alphabetically) or a list of http paths (separated by ";").
 
 ::
@@ -62,7 +63,7 @@ All of the **Agents** implemented within CGRateS are flexible to be configured w
 Following *Agents* are implemented within CGRateS:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    diamagent
    radagent

docs/diamagent.rst

@@ -5,20 +5,23 @@
 DiameterAgent
 =============
 
-**DiameterAgent** translates between Diameter_ and **CGRateS**, sending *RPC* requests towards **SessionS** component and returning replies from it to the *DiameterClient*.
+**DiameterAgent** translates between Diameter_ and **CGRateS**, sending *RPC* requests towards **CGRateS/SessionS** component and returning replies from it to the *DiameterClient*.
 
 Implements Diameter_ protocol in a standard agnostic manner, giving users the ability to implement own interfaces by defining simple *processor templates* within the :ref:`configuration <engine_configuration>`  files.
 
 Used mostly in modern mobile networks (LTE/xG).
 
+The **DiameterAgent** is configured via *diameter_agent* section  within :ref:`configuration <engine_configuration>`.
+
 
 Configuration
 -------------
 
-The **DiameterAgent** is configured via *diameter_agent* section  within :ref:`configuration <engine_configuration>`.
 
+Sample config 
+^^^^^^^^^^^^^
 
-Sample config (explanation in the comments):
+With explanations in the comments:
 
 ::
 
@@ -174,4 +177,14 @@ Sample config (explanation in the comments):
  },
 
 
+Config params
+^^^^^^^^^^^^^
+
+listen_net
+	The network the *DiameterAgent* will bind to. CGRateS supports both **tcp** and **sctp** specified in Diameter_ standard.
+
+asr_template
+	The template (out of templates config section) used to build the AbortSession message. If not specified the ASR message is never sent out.
+
+
 

docs/index.rst

@@ -1,7 +1,7 @@
 .. _CGRateS: http://cgrates.org
 
-Preface
-=======
+CGRateS Documentation
+=====================
 
 Welcome to `CGRateS`_'s documentation!
 
@@ -9,7 +9,7 @@ Welcome to `CGRateS`_'s documentation!
 
 
 .. toctree::
-   :maxdepth: 5
+   :maxdepth: 4
    
    overview
    architecture

docs/overview.rst

@@ -11,6 +11,11 @@
 .. _FreeSWITCH: https://freeswitch.com/
 .. _Kamailio: https://www.kamailio.org/w/
 .. _OpenSIPS: https://opensips.org/
+.. _Diameter: https://tools.ietf.org/html/rfc6733
+.. _Radius: https://tools.ietf.org/html/rfc2865
+.. _DNS: https://tools.ietf.org/html/rfc1034
+.. _ENUM: https://tools.ietf.org/html/rfc6116
+
 
 
 
@@ -160,10 +165,10 @@ Features
     - FreeSWITCH_
     - Kamailio_
     - OpenSIPS_
-    - Diameter
-    - Radius
+    - Diameter_
+    - Radius_
     - Generic HTTP
-    - DNS/ENUM.
+    - DNS_/ENUM_.
 
 - Built in High-Availability mechanisms:
     - Dispatcher with static or dynamic routing