From 609a9a129d003f0e9809b95278b268a762b1b141 Mon Sep 17 00:00:00 2001 From: ionutboangiu Date: Fri, 5 May 2023 12:33:09 -0400 Subject: [PATCH] Revise doc for fs install + warning fixes --- docs/diamagent.rst | 2 +- docs/ers.rst | 2 +- docs/rals.rst | 6 +++--- docs/stats.rst | 2 +- docs/suppliers.rst | 16 ++++++++-------- docs/troubleshooting.rst | 2 +- docs/tut_cgrates_usage.rst | 6 ++++-- docs/tut_freeswitch_installs.rst | 33 ++++++++++++++++---------------- docs/tut_opensips.rst | 2 +- 9 files changed, 36 insertions(+), 35 deletions(-) diff --git a/docs/diamagent.rst b/docs/diamagent.rst index 471f5386e..3016ac868 100644 --- a/docs/diamagent.rst +++ b/docs/diamagent.rst @@ -393,7 +393,7 @@ flags Auxiliary flags available: all flags supported by the "SessionSv1.ProcessEvent" generic API **\*cdrs** - Build a CDR out of the request on CGRateS side. Can be used simultaneously with other flags (except *\*dry_run) + Build a CDR out of the request on CGRateS side. Can be used simultaneously with other flags (except **\*dryrun**) path diff --git a/docs/ers.rst b/docs/ers.rst index 2646c64fa..966829b22 100644 --- a/docs/ers.rst +++ b/docs/ers.rst @@ -242,7 +242,7 @@ flags Auxiliary flags available: all flags supported by the "SessionSv1.ProcessEvent" generic API **\*cdrs** - Build a CDR out of the Event on CGRateS side. Can be used simultaneously with other flags (except *\*dry_run) + Build a CDR out of the Event on CGRateS side. Can be used simultaneously with other flags (except **\*dryrun**) path Defined within field, specifies the path where the value will be written. Possible values: diff --git a/docs/rals.rst b/docs/rals.rst index 4f8e05089..aa2dba51d 100644 --- a/docs/rals.rst +++ b/docs/rals.rst @@ -243,10 +243,10 @@ The following *BalanceTypes* are supported: Coupled with MMS events, represents number of MMS units. \*generic - Matching all types of events after specific ones, represents generic units (ie: for each x *voice minutes, y *sms units, z *data units will have ) + Matching all types of events after specific ones, representing generic units (i.e., for each x \*voice minutes, y \*sms units, and z \*data units will have their respective usage) \*monetary - Matching all types of events after specific ones, represents monetary units (can be interpreted as virtual currency). + Matching all types of events after specific ones, representing monetary units (can be interpreted as virtual currency). @@ -381,7 +381,7 @@ Action Actions are routines executed on demand (ie. by one of the three subsystems: :ref:`SchedulerS`, :ref:`ThresholdS` or :ref:`ActionTriggers `) or called by API by external scripts. -An *Action has the following parameters: +An \*Action has the following parameters: ID *ActionSet* identifier. diff --git a/docs/stats.rst b/docs/stats.rst index 81d45076d..a6169ad42 100644 --- a/docs/stats.rst +++ b/docs/stats.rst @@ -140,7 +140,7 @@ Use cases * Aggregate various traffic metrics for traffic transparency. * Revenue assurance applications. -* Fraud detection by aggregating specific billing metrics during sensitive time intervals (*acc, *tcc, *tcd). +* Fraud detection by aggregating specific billing metrics during sensitive time intervals (\*acc, \*tcc, \*tcd). * Building call patterns. * Building statistical information to train systems capable of artificial intelligence. * Building quality metrics used in traffic routing. diff --git a/docs/suppliers.rst b/docs/suppliers.rst index 89186277a..39a4377dd 100644 --- a/docs/suppliers.rst +++ b/docs/suppliers.rst @@ -73,13 +73,13 @@ attributes_conns Connections to AttributeS for altering events before supplier queries. If undefined, fields modifications are disabled. resources_conns - Connections to ResourceS for *res sorting, empty to disable functionality. + Connections to ResourceS for \*res sorting, empty to disable functionality. stats_conns - Connections to StatS for *stats sorting, empty to disable stats functionality. + Connections to StatS for \*stats sorting, empty to disable stats functionality. default_ratio - Default ratio used in case of *load strategy + Default ratio used in case of \*load strategy .. _SupplierProfile: @@ -159,19 +159,19 @@ FilterIDs List of *FilterProfileIDs* which should match in order to consider the *Supplier* in use/active. AccountIDs - List of account IDs which should be checked in case of some strategies (ie: *lc, *hc). + List of account IDs which should be checked in case of some strategies (ie: \*lc, \*hc). RatingPlanIDs - List of RatingPlanIDs which should be checked in case of some strategies (ie: *lc, *hc). + List of RatingPlanIDs which should be checked in case of some strategies (ie: \*lc, \*hc). ResourceIDs - List of ResourceIDs which should be checked in case of some strategies (ie: *reas or *reds). + List of ResourceIDs which should be checked in case of some strategies (ie: \*reas or \*reds). StatIDs - List of StatIDs which should be checked in case of some strategies (ie: *qos or *load). Can also be defined as *StatID:MetricID*. + List of StatIDs which should be checked in case of some strategies (ie: \*qos or \*load). Can also be defined as *StatID:MetricID*. Weight - Used for sorting in some strategies (ie: *weight, *lc or *hc). + Used for sorting in some strategies (ie: \*weight, \*lc or \*hc). Blocker No more suppliers are provided after this one. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 4d294dd63..927fbb18b 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -6,7 +6,7 @@ In case of **troubleshooting**, CGRateS can monitor memory profiling and CPU pro Memory Profiling ---------------- -Creating the memory profile files. +Creating the memory profile files ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Firstly, go to the main config directory and run the engine with the flag named ```-memprof_dir```. For this example, I choosed ```tmp``` directory from my machine. diff --git a/docs/tut_cgrates_usage.rst b/docs/tut_cgrates_usage.rst index 5c1c945ca..dc2b9f3f7 100644 --- a/docs/tut_cgrates_usage.rst +++ b/docs/tut_cgrates_usage.rst @@ -21,8 +21,10 @@ following rules: - Rate id: *RT_1CNT_PER_SEC* having no connect fee and a rate of 1 cent per second, chargeable in 1 second increments. - Accounting part will have following configured: - - Create 3 accounts: 1001, 1002, 1003. - - 1001, 1002 will receive 10units of *\*monetary* balance. + + - Create 3 accounts: 1001, 1002, 1003. + - 1001, 1002 will receive 10units of **\*monetary** balance. + :: diff --git a/docs/tut_freeswitch_installs.rst b/docs/tut_freeswitch_installs.rst index 849442842..6a790f8c0 100644 --- a/docs/tut_freeswitch_installs.rst +++ b/docs/tut_freeswitch_installs.rst @@ -1,38 +1,37 @@ -Software installation +Software Installation ===================== -As operating system we have chosen Debian Jessie, since all the software components we use provide packaging for it. +We recommend using Debian 11 (Bullseye) as the operating system because all the software components we use provide packaging for it. CGRateS --------- +------- -**CGRateS** can be installed using the instructions found :ref:`here`. +You can install **CGRateS** by following the instructions provided in the :ref:`installation` section. +FreeSWITCH +---------- +For detailed information on installing FreeSWITCH on Debian, please refer to its official `installation wiki `_. +Before installing FreeSWITCH, you need to authenticate by creating a SignalWire Personal Access Token. To generate your personal token, follow the instructions in the `SignalWire official wiki on creating a personal token `_. -FreeSWITCH_ ------------ +To install FreeSWITCH and configure it, we have chosen the simplest method using *vanilla* packages. -More information regarding the installation of FreeSWITCH_ on Debian can be found on it's official `installation wiki `_. - -Firstly, in order to install FreeSWITCH_, the authentication is required by creating a SignalWire Personal Access Token. Before instalation, it's needed to generate the personal token and this cand be found on :ref:`SignalWire official wiki in creating a personal token`. - -To get FreeSWITCH_ installed and configured, we have choosen the simplest method, out of *vanilla* packages, plus one individual module we need: *mod-json-cdr*. - -We will install FreeSWITCH_ via following commands: +Install FreeSWITCH by running the following commands: :: - TOKEN=YOURSIGNALWIRETOKEN # here insert your SignalWire Personal Acces Token + + TOKEN=YOURSIGNALWIRETOKEN # Insert your SignalWire Personal Access Token here + apt-get update && apt-get install -y gnupg2 wget lsb-release wget --http-user=signalwire --http-password=$TOKEN -O /usr/share/keyrings/signalwire-freeswitch-repo.gpg https://freeswitch.signalwire.com/repo/deb/debian-release/signalwire-freeswitch-repo.gpg echo "machine freeswitch.signalwire.com login signalwire password $TOKEN" > /etc/apt/auth.conf chmod 600 /etc/apt/auth.conf echo "deb [signed-by=/usr/share/keyrings/signalwire-freeswitch-repo.gpg] https://freeswitch.signalwire.com/repo/deb/debian-release/ `lsb_release -sc` main" > /etc/apt/sources.list.d/freeswitch.list echo "deb-src [signed-by=/usr/share/keyrings/signalwire-freeswitch-repo.gpg] https://freeswitch.signalwire.com/repo/deb/debian-release/ `lsb_release -sc` main" >> /etc/apt/sources.list.d/freeswitch.list - # if /etc/freeswitch does not exist, the standard vanilla configuration is deployed - apt-get update && apt-get install -y freeswitch-meta-allapt-get update && apt-get install -y freeswitch-meta-all + # If /etc/freeswitch does not exist, the standard vanilla configuration is deployed + apt-get update && apt-get install -y freeswitch-meta-all -Once installed, we will proceed with loading the configuration out of specific tutorial cases bellow. +After the installation, proceed with loading the configuration for specific tutorial cases provided below. .. _FreeSWITCH: https://freeswitch.com// diff --git a/docs/tut_opensips.rst b/docs/tut_opensips.rst index ee196bd7e..e7f4782b8 100644 --- a/docs/tut_opensips.rst +++ b/docs/tut_opensips.rst @@ -8,7 +8,7 @@ In these tutorials we exemplify a few cases of integration between OpenSIPS_ and :maxdepth: 2 tut_opensips_installs - tut_osips_native + tut_opensips_native tut_cgrates_usage .. _OpenSIPS: https://opensips.org/