mirror of
https://github.com/cgrates/cgrates.git
synced 2026-02-11 10:06:24 +05:00
Revise doc for fs install + warning fixes
This commit is contained in:
ionutboangiu
committed by
Dan Christian Bogos
Dan Christian Bogos
parent
d64ce92a2d
commit
6911b4fb10
@@ -290,7 +290,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
|
||||
|
||||
@@ -236,7 +236,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:
|
||||
|
||||
@@ -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 <ActionTrigger>`) or called by API by external scripts.
|
||||
|
||||
An *Action has the following parameters:
|
||||
An \*Action has the following parameters:
|
||||
|
||||
ID
|
||||
*ActionSet* identifier.
|
||||
|
||||
@@ -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 routes are provided after this one.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
- 1001, 1002 will receive 10units of **\*monetary** balance.
|
||||
|
||||
|
||||
::
|
||||
|
||||
|
||||
@@ -1,37 +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<installation>`.
|
||||
You can install **CGRateS** by following the instructions provided in the :ref:`installation<installation>` section.
|
||||
|
||||
FreeSWITCH
|
||||
----------
|
||||
|
||||
For detailed information on installing FreeSWITCH on Debian, please refer to its official `installation wiki <https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Installation/Linux/Debian_67240088/>`_.
|
||||
|
||||
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 <https://developer.signalwire.com/freeswitch/freeswitch-explained/installation/howto-create-a-signalwire-personal-access-token_67240087/>`_.
|
||||
|
||||
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 <https://freeswitch.org/confluence/display/FREESWITCH/FreeSWITCH+1.6+Video>`_.
|
||||
|
||||
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<https://developer.signalwire.com/freeswitch/FreeSWITCH-Explained/Installation/HOWTO-Create-a-SignalWire-Personal-Access-Token_67240087/#attachments>`.
|
||||
|
||||
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
|
||||
|
||||
Once installed, we will proceed with loading the configuration out of specific tutorial cases bellow.
|
||||
# If /etc/freeswitch does not exist, the standard vanilla configuration is deployed
|
||||
apt-get update && apt-get install -y freeswitch-meta-all
|
||||
|
||||
After the installation, proceed with loading the configuration for specific tutorial cases provided below.
|
||||
|
||||
.. _FreeSWITCH: https://freeswitch.com//
|
||||
|
||||
Reference in New Issue
Block a user