uppal/cgrates
1
0
Fork 1
mirror of https://github.com/cgrates/cgrates.git synced 2026-02-11 18:16:24 +05:00
Code Issues Packages Projects Releases Wiki Activity

Docs corrections

Browse Source
This commit is contained in:
alin104n
2017-07-06 22:40:27 +03:00
parent ba2f229a86
commit c517c030b2
10 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/overview.rst
View File

@@ -23,7 +23,7 @@ dedicated benchmark tool,
asynchronous request processing,
own transactional cache with majority of handled data loaded on start or reloaded during runtime,
)
however not loosing focus of **quality** (over 1300 tests part of the build environment).
however not losing focus of **quality** (over 1300 tests part of the build environment).
Modular and flexible, CGRateS provides APIs over a variety of simultaneously accessible communication interfaces:
- **In-process** : optimal when there is no need to split services over different processes.

2
docs/tut_asterisk.rst
View File

@@ -1,7 +1,7 @@
Asterisk_ Integration Tutorials
===============================
In these tutorials we exemplify few cases of integration between Asterisk_ 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 a few cases of integration between Asterisk_ and CGRateS_. We start with common steps, installation and postinstall processes, then we dive into particular configurations, depending on the case we run.
.. toctree::

2
docs/tut_asterisk_installs.rst
View File

@@ -1,7 +1,7 @@
Software installation
=====================
As operating system we have choosen Debian stable.
We have chosen Debian Jessie as operating system.
Asterisk_
---------

14
docs/tut_cgrates_installs.rst
View File

@@ -1,12 +1,12 @@
**CGRateS** Installation
========================
As operating system we have choosen Debian Wheezy, since all the software components we use provide packaging for it.
We have chosen Debian Jessie as operating system, since all the software components we use provide packaging for it.
Prerequisites
-------------
Some components of **CGRateS** (whether enabled or not is up to the administrator) depend on external software like:
Some components of **CGRateS** (whether enabled or not, is up to the administrator) depend on external software like:
- Git_ used by **CGRateS** History Server as archiver.
- Redis_ to serve as Rating and Accounting DB for **CGRateS**.
@@ -18,15 +18,15 @@ We will install them in one shot using the command bellow.
apt-get install git redis-server mysql-server
*Note*: For simplicity sake we have used as MySQL_ root password when asked: *CGRateS.org*.
*Note*: We will use this MySQL_ root password when asked: *CGRateS.org*.
Installation
------------
Installation steps are provided within **CGRateS** `install documentation <https://cgrates.readthedocs.org/en/latest/installation.html>`_.
Installation steps are provided within the **CGRateS** `install documentation <https://cgrates.readthedocs.org/en/latest/installation.html>`_.
Since this tutorial is for master version of **CGRateS** we will install CGRateS out of temporary .deb packages built out of master code:
Since this tutorial is for master version of **CGRateS**, we will install CGRateS out of temporary .deb packages built out of master code:
::
@@ -41,8 +41,8 @@ As described in post-install section, we will need to set up the MySQL_ database
./setup_cgr_db.sh root CGRateS.org localhost
At this point we have **CGRateS** installed but not yet configured. To facilitate the understanding and speed up the process, **CGRateS** comes already with the configurations used in these tutorials, available in the */usr/share/cgrates/tutorials* folder, so we will load them custom on each tutorial case.
At this point we have **CGRateS** installed but not yet configured. To facilitate understanding and speed up the process, **CGRateS** has the configurations used in these tutorials available in the */usr/share/cgrates/tutorials* folder.
.. _Redis: http://redis.io/
.. _MySQL: http://www.mysql.org/
.. _Git: http://git-scm.com/
.. _Git: http://git-scm.com/

2
docs/tut_freeswitch.rst
View File

@@ -1,7 +1,7 @@
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.
In these tutorials we exemplify a few cases of integration between FreeSWITCH_ and **CGRateS**. We start with common steps, installation and postinstall processes, then we dive into particular configurations.
.. toctree::

8
docs/tut_freeswitch_installs.rst
View File

@@ -7,11 +7,11 @@ As operating system we have chosen Debian Jessie, since all the software compone
FreeSWITCH_
-----------
More information regarding installing FreeSWITCH_ on Debian can be found on it's official `installation wiki <https://freeswitch.org/confluence/display/FREESWITCH/FreeSWITCH+1.6+Video>`_.
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>`_.
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*.
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 got FreeSWITCH_ installed via following commands:
We will install FreeSWITCH_ via following commands:
::
@@ -20,6 +20,6 @@ We got FreeSWITCH_ installed via following commands:
apt-get update
apt-get install freeswitch-meta-vanilla freeswitch-mod-json-cdr libyuv-dev
Once installed we proceed with loading the configuration out of specific tutorial cases bellow.
Once installed, we will proceed with loading the configuration out of specific tutorial cases bellow.
.. _FreeSWITCH: http://www.freeswitch.org/

2
docs/tut_kamailio.rst
View File

@@ -1,7 +1,7 @@
Kamailio_ Integration Tutorials
===============================
In these tutorials we exemplify few cases of integration between Kamailio_ 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 a few cases of integration between Kamailio_ and CGRateS_. We start with common steps, installation and postinstall processes, then we dive into particular configurations, depending on the case we run.
.. toctree::

2
docs/tut_kamailio_installs.rst
View File

@@ -1,7 +1,7 @@
Software installation
=====================
As operating system we have choosen Debian Jessie, since all the software components we use provide packaging for it.
We have chosen Debian Jessie as operating system, since all the software components we use provide packaging for it.
Kamailio_
---------

2
docs/tut_opensips.rst
View File

@@ -1,7 +1,7 @@
OpenSIPS_ Integration Tutorials
===============================
In these tutorials we exemplify few cases of integration between OpenSIPS_ 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 a few cases of integration between OpenSIPS_ and CGRateS_. We start with common steps, installation and postinstall processes, then we dive into particular configurations, depending on the case we run.
.. toctree::

2
docs/tut_opensips_installs.rst
View File

@@ -1,7 +1,7 @@
Software installation
=====================
As operating system we have choosen Debian Jessie, since all the software components we use provide packaging for it.
We have chosen Debian Jessie as operating system, since all the software components we use provide packaging for it.
OpenSIPS_
---------