mirror of
https://github.com/cgrates/cgrates.git
synced 2026-02-16 21:59:53 +05:00
New kamailio tutorial in docs, various doc improvements, fixes in local calls
This commit is contained in:
@@ -45,18 +45,20 @@ Database setup
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
For it's operation CGRateS uses more database types, depending on it's nature, install and configuration being further necessary.
|
||||
|
||||
At present we support the following databases:
|
||||
|
||||
As DataDB types (rating and accounting subsystems):
|
||||
|
||||
|
||||
- Redis_
|
||||
|
||||
As StorDB (persistent storage for CDRs and tariff plan versions).
|
||||
|
||||
Used as DataDb, optimized for real-time information access.
|
||||
Once installed there should be no special requirements in terms of setup since no schema is necessary.
|
||||
|
||||
|
||||
- MySQL_
|
||||
|
||||
Used as StorDb, optimized for CDR archiving and offline Tariff Plan versioning.
|
||||
Once database is installed, CGRateS database needs to be set-up out of provided scripts (example for the paths set-up by debian package)
|
||||
|
||||
::
|
||||
@@ -66,12 +68,13 @@ Once database is installed, CGRateS database needs to be set-up out of provided
|
||||
|
||||
- PostgreSQL_
|
||||
|
||||
Used as StorDb, optimized for CDR archiving and offline Tariff Plan versioning.
|
||||
Once database is installed, CGRateS database needs to be set-up out of provided scripts (example for the paths set-up by debian package)
|
||||
|
||||
::
|
||||
|
||||
cd /usr/share/cgrates/storage/postgres/
|
||||
./setup_cgr_db.sh root CGRateS.org localhost
|
||||
./setup_cgr_db.sh
|
||||
|
||||
.. _Redis: http://redis.io/
|
||||
.. _MySQL: http://www.mysql.org/
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
sFreeSWITCH Integration Tutorials
|
||||
FreeSWITCH Integration Tutorials
|
||||
================================
|
||||
|
||||
In these tutorials we exemplify few cases of integration between FreeSWITCH_ and **CGRateS**. We start with common steps, installation and postinstall processes then we dive into particular configurations, depending on the case we run.
|
||||
In these tutorials we exemplify few cases of integration between FreeSWITCH_ and **CGRateS**. We start with common steps, installation and postinstall processes then we dive into particular configurations.
|
||||
|
||||
|
||||
.. toctree::
|
||||
@@ -10,7 +10,6 @@ In these tutorials we exemplify few cases of integration between FreeSWITCH_ and
|
||||
tut_freeswitch_installs
|
||||
tut_cgrates_installs
|
||||
tut_jitsi_installs
|
||||
tut_freeswitch_csv
|
||||
tut_freeswitch_json
|
||||
tut_cgrates_usage
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ FreeSWITCH_ generating *http-json* CDRs
|
||||
Scenario
|
||||
--------
|
||||
|
||||
- FreeSWITCH with *vanilla* configuration, replacing *mod_cdr_csv* with *mod_json_cdr*.
|
||||
- FreeSWITCH with *vanilla* configuration adding *mod_json_cdr* for CDR generation.
|
||||
|
||||
- Modified following users (with configs in *etc/freeswitch/directory/default*): 1001-prepaid, 1002-postpaid, 1003-pseudoprepaid, 1004-rated, 1006-prepaid, 1007-rated.
|
||||
- Have added inside default dialplan CGR own extensions just before routing towards users (*etc/freeswitch/dialplan/default.xml*).
|
||||
@@ -13,8 +13,8 @@ Scenario
|
||||
- **CGRateS** with following components:
|
||||
|
||||
- CGR-SM started as prepaid controller, with debits taking place at 5s intervals.
|
||||
- CGR-Mediator component attaching costs to the raw CDRs from FreeSWITCH_ inside CGR StorDB.
|
||||
- CGR-CDRE exporting mediated CDRs from CGR StorDB (export path: */tmp*).
|
||||
- CGR-CDRS component receiving raw CDRs from FreeSWITCH, storing them and attaching costs inside CGR StorDB.
|
||||
- CGR-CDRE exporting processed CDRs from CGR StorDB (export path: */tmp*).
|
||||
- CGR-History component keeping the archive of the rates modifications (path browsable with git client at */tmp/cgr_history*).
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ Starting FreeSWITCH_ with custom configuration
|
||||
|
||||
::
|
||||
|
||||
/usr/share/cgrates/tutorials/fs_json/freeswitch/etc/init.d/freeswitch start
|
||||
/usr/share/cgrates/tutorials/fs_evsock/freeswitch/etc/init.d/freeswitch start
|
||||
|
||||
To verify that FreeSWITCH_ is running we run the console command:
|
||||
|
||||
@@ -37,7 +37,7 @@ Starting **CGRateS** with custom configuration
|
||||
|
||||
::
|
||||
|
||||
/usr/share/cgrates/tutorials/fs_json/cgrates/etc/init.d/cgrates start
|
||||
/usr/share/cgrates/tutorials/fs_evsock/cgrates/etc/init.d/cgrates start
|
||||
|
||||
Check that cgrates is running
|
||||
|
||||
@@ -49,7 +49,7 @@ Check that cgrates is running
|
||||
CDR processing
|
||||
--------------
|
||||
|
||||
At the end of each call FreeSWITCH_ will issue a http post with the CDR. This will reach inside **CGRateS** through the *CDRS* component (close to real-time). Once in-there it will be instantly mediated and it is ready to be exported:
|
||||
At the end of each call FreeSWITCH_ will issue a http post with the CDR. This will reach inside **CGRateS** through the *CDRS* component (close to real-time). Once in-there it will be instantly rated and it is ready to be exported:
|
||||
|
||||
::
|
||||
|
||||
|
||||
@@ -12,8 +12,8 @@ Scenario
|
||||
- **CGRateS** with following components:
|
||||
|
||||
- CGR-SM started as translator between OpenSIPS_ and **cgr-rater** for both authorization events (pseudoprepaid) as well as CDR ones.
|
||||
- CGR-Mediator component attaching costs to the raw CDRs from OpenSIPS_ inside CGR StorDB.
|
||||
- CGR-CDRE exporting mediated CDRs from CGR StorDB (export path: */tmp*).
|
||||
- CGR-CDRS component processing raw CDRs from CGR-SM component and storing them inside CGR StorDB.
|
||||
- CGR-CDRE exporting rated CDRs from CGR StorDB (export path: */tmp*).
|
||||
- CGR-History component keeping the archive of the rates modifications (path browsable with git client at */tmp/cgr_history*).
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Starting OpenSIPS_ with custom configuration
|
||||
|
||||
::
|
||||
|
||||
/usr/share/cgrates/tutorials/osips_event/opensips/etc/init.d/opensips start
|
||||
/usr/share/cgrates/tutorials/osips_async/opensips/etc/init.d/opensips start
|
||||
|
||||
To verify that OpenSIPS_ is running we run the console command:
|
||||
|
||||
@@ -36,9 +36,9 @@ Starting **CGRateS** with custom configuration
|
||||
|
||||
::
|
||||
|
||||
/usr/share/cgrates/tutorials/osips_event/cgrates/etc/init.d/cgrates start
|
||||
/usr/share/cgrates/tutorials/osips_async/cgrates/etc/init.d/cgrates start
|
||||
|
||||
Check that cgrates is running
|
||||
Make sure that cgrates is running
|
||||
|
||||
::
|
||||
|
||||
@@ -48,7 +48,7 @@ Check that cgrates is running
|
||||
CDR processing
|
||||
--------------
|
||||
|
||||
At the end of each call OpenSIPS_ will generate an CDR event and due to automatic handler registration built in **CGRateS-SM** component, this will be directed towards the port configured inside *cgrates.cfg*. This event will reach inside **CGRateS** through the *SM* component (close to real-time). Once in-there it will be instantly mediated and it is ready to be exported.
|
||||
At the end of each call OpenSIPS_ will generate an CDR event and due to automatic handler registration built in **CGRateS-SM** component, this will be directed towards the port configured inside *cgrates.json*. This event will reach inside **CGRateS** through the *SM* component (close to real-time). Once in-there it will be instantly rated and be ready for export.
|
||||
|
||||
|
||||
**CGRateS** Usage
|
||||
|
||||
@@ -12,9 +12,9 @@ We got OpenSIPS_ installed via following commands:
|
||||
wget http://apt.opensips.org/key.asc
|
||||
apt-key add key.asc
|
||||
cd /etc/apt/sources.list.d/
|
||||
wget http://apt.itsyscom.com/conf/opensips.apt.list
|
||||
wget http://apt.itsyscom.com/conf/opensips.wheezy.apt.list
|
||||
apt-get update
|
||||
apt-get install
|
||||
apt-get install opensips opensips-json-module opensips-restclient-module
|
||||
|
||||
Once installed we proceed with loading the configuration out of specific tutorial cases bellow.
|
||||
|
||||
|
||||
@@ -5,4 +5,5 @@
|
||||
:maxdepth: 2
|
||||
|
||||
tut_freeswitch
|
||||
tut_kamailio
|
||||
tut_opensips
|
||||
|
||||
Reference in New Issue
Block a user