sip3io · zavndw · Jul 21, 2021 · Jul 21, 2021 · Aug 10, 2021 · Sep 12, 2021
diff --git a/modules/ROOT/pages/GettingStartedGuide.adoc b/modules/ROOT/pages/GettingStartedGuide.adoc
@@ -1,4 +1,39 @@
 = Getting Started
 :description: SIP3 Getting Started Guide
 
+Clone the repository from the beginning:
+
+[source,ssh]
+----
+git clone https://github.com/sip3io/sip3-ansible.git
+git checkout -b release/2021.2.3
+----
+
+Next, edit the example configuration file for the backend and captain (change ansible_host to your value)
+
+[source,ssh]
+----
+nano examples/sip3-backend.yml
+nano examples/sip3-captain.yml
+----
+
+Next, run ansible command:
+
+1) If the installation is performed on a remote machine:
+[source,ssh]
+----
+From backend:
+ansible-playbook -i examples/sip3-backend.yml playbooks/sip3.yml
+From captain:
+ansible-playbook -i examples/sip3-captain.yml playbooks/sip3.yml
+----
+
+2) If the installation is performed on a local machine:
+[source,ssh]
+----
+From backend:
+ansible-playbook --connection=local -i examples/sip3-backend.yml playbooks/sip3.yml
+From captain:
+ansible-playbook --connection=local -i examples/sip3-captain.yml playbooks/sip3.yml
+----
 This document will be updated soon...
diff --git a/modules/ROOT/pages/InstallationGuide.adoc b/modules/ROOT/pages/InstallationGuide.adoc
@@ -35,8 +35,7 @@ Clone `sip3-ansible` repository and checkout the latest release branch:
 
 [source,ssh]
 ----
-git clone https://github.com/sip3io/sip3-ansible.git
-git checkout -b release/2021.1.1
+git clone https://github.com/sip3io/sip3-ansible.git -b release/20XX.X.X (20XX.X.X - current release)
 ----
 
 Create a `sip3-captain.yml` file inside the `inventories` directory:
@@ -52,20 +51,17 @@ all:
     ansible_port: 22
     ansible_become: true
 
-    platform: centos                                  // <2>
-    edition: ce
-    version: 2020.1.1
-
-    features:                                         // <3>
+    features:                                         // <2>
       - rtcp
+      - udf
 
     captain:
-      pcap:                                           // <4>
+      pcap:                                           // <3>
         dev: eth0
         bpf_filter: udp
-      sender:                                         // <5>
+      sender:                                         // <4>
         uri: udp://192.168.1.2:15060
-      management:                                     // <6>
+      management:                                     // <5>
         uri: udp://192.168.1.2:15090
       metrics:
         logging:
@@ -77,20 +73,17 @@ Let's take a closer look at the inventory file:
 <1> SSH address.
 Ansible uses it to connect to the PBX via SSH.
 
-<2> Platform and the component version.
-At the moment you can choose between `centos` and `docker` platforms.
-
-<3> Features help to customize SIP3 behaviour and enable/disable certain functionality.
+<2> Features help to customize SIP3 behaviour and enable/disable certain functionality.
 They also help to separate CE and EE configuration.
 You can find more information in the corresponding section of this document.
 
-<4> Standard `libpcap` settings.
+<3> Standard `libpcap` settings.
 Specify on which interface you want to capture VoIP traffic and set https://biot.com/capstats/bpf.html[BPF filter] to avoid capturing all the packets (e.g. If you want to capture only SIP protocol on port 5060 use `udp and port 5060` as a filter).
 
-<5> SIP3 Salto data interface.
+<4> SIP3 Salto data interface.
 SIP3 Captain uses this interface to send application data.
 
-<6> Management interface.
+<5> Management interface.
 Must be defined if `rtp` or `rtcp` features enabled.
 SIP3 Salto and Captain use this interface to exchange SDP information.
 
@@ -144,10 +137,6 @@ all:
     ansible_port: 22
     ansible_become: true
 
-    platform: centos
-    edition: ce
-    version: 2020.1.1
-
     features:
       - rtcp
 
@@ -200,54 +189,47 @@ all:
     ansible_port: 22
     ansible_become: true
 
-    platform: centos                                  // <2>
-    edition: ce
-    version: 2020.1.1
-
-    features:                                         // <3>
+    features:                                         // <2>
       - call
       - register
       - rtcp
 
-    mongodb:                                          // <4>
+    mongodb:                                          // <3>
       version: 4.2
       path: /var/lib/mongodb
       db: sip3
-    influxdb:                                         // <5>
+    influxdb:                                         // <4>
       path: /var/lib/influxdb
       db: sip3
-    grafana:                                          // <6>
+    grafana:                                          // <5>
       datasources:
         database: sip3
     salto:
-      server:                                         // <7>
+      server:                                         // <6>
         uri: udp://0.0.0.0:15060
       management:
-        uri: udp://0.0.0.0:15090                      // <8>
+        uri: udp://0.0.0.0:15090                      // <7>
 ----
 
 Let's take a closer look at the inventory file:
 
 <1> SSH address.
 Ansible uses it to connect to the SIP3 backend via SSH.
 
-<2> Platform and the component version.
-At the moment you can choose between `centos` and `docker` platforms.
-
-<3> Features help to customize SIP3 behaviour and enable/disable certain functionality.
+<2> Features help to customize SIP3 behaviour and enable/disable certain functionality.
 They also help to separate CE and EE configuration.
 You can find more information in the corresponding section of this document.
 
-<4> MongoDB section where you can put a specific version, path and name of the database.
+<3> MongoDB section where you can put a specific version, path and name of the database.
 
-<5> InfluxDB section where you can put a specific version, path and name of the database.
+<4> InfluxDB section where you can put a specific version, path and name of the database.
 
-<6> Grafana section where you can configure `sip3` datasource.
+<5> Grafana section where you can configure `sip3` datasource.
 
-<7> SIP3 Salto data interface.
+<6> SIP3 Salto data interface.
 SIP3 Captain uses this interface to send application data.
 
-<8> Management interface.
+<7> Management interface.
 Must be defined if `rtp` or `rtcp` features enabled.
 SIP3 Salto and Captain use this interface to exchange SDP information.
 
@@ -259,4 +241,4 @@ Now let's install SIP3 backend components by running the same simple command:
 ansible-playbook -i inventories/sip3-backend.yml playbooks/sip3.yml
 ```
 
-This document will be updated soon...
+This document will be updated soon...
diff --git a/modules/ROOT/pages/features/UserDefinedFunctions.adoc b/modules/ROOT/pages/features/UserDefinedFunctions.adoc
@@ -15,6 +15,7 @@ This document will walk you though the process of writing UDFs. For more informa
 
 == User-Defined Function Base Structure
 
+By after enable features in ansible playbook, in file /etc/sip3-salto/environment.conf will be added param "udf.location" and her default path "/opt/sip3-salto/udf"
 To better understand SIP3 UDF structure let's analyze following `sip_message_udf` example:
 
 ++++
@@ -458,4 +459,4 @@ eventBus.localConsumer("sip_call_udf", function (event) {
 ----
 ++++
 </details>
-++++
+++++