From 5c217fd739d8f810e18cf82cccf6cf200c9f0546 Mon Sep 17 00:00:00 2001 From: Trial97 Date: Fri, 10 Jan 2020 13:42:01 +0200 Subject: [PATCH] Updated documentation --- data/docker/prod/Dockerfile | 2 +- docs/index.rst | 2 +- docs/installation.rst | 2 ++ docs/tut_asterisk.rst | 1 - docs/tut_asterisk_installs.rst | 6 ++++ docs/tut_cgrates_installs.rst | 52 -------------------------------- docs/tut_freeswitch.rst | 1 - docs/tut_freeswitch_installs.rst | 7 +++++ docs/tut_kamailio.rst | 1 - docs/tut_kamailio_installs.rst | 7 +++++ docs/tut_opensips.rst | 1 - docs/tut_opensips_installs.rst | 6 ++++ 12 files changed, 30 insertions(+), 58 deletions(-) delete mode 100644 docs/tut_cgrates_installs.rst diff --git a/data/docker/prod/Dockerfile b/data/docker/prod/Dockerfile index cf37b5a2f..029c83fbd 100644 --- a/data/docker/prod/Dockerfile +++ b/data/docker/prod/Dockerfile @@ -27,7 +27,7 @@ RUN apt-get update && apt-get -y install redis-server mysql-server python-pycurl #RUN apt-get update && apt-get -y install cgrates # CGRateS -RUN wget -O /tmp/cgrates.deb http://www.cgrates.org/tmp_pkg/cgrates_0.9.1~rc8_amd64.deb +RUN wget -O /tmp/cgrates.deb http://pkg.cgrates.org/debian/cgrates_current_amd64.deb RUN apt install /tmp/cgrates.deb RUN rm /tmp/cgrates.deb diff --git a/docs/index.rst b/docs/index.rst index edc378448..f207e81f2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,7 +15,7 @@ Full contents: introduction architecture installation - configuration + configuration administration advanced tutorials diff --git a/docs/installation.rst b/docs/installation.rst index 09e07f333..a22512f07 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,3 +1,5 @@ +.. _installation: + 3. Installation =============== diff --git a/docs/tut_asterisk.rst b/docs/tut_asterisk.rst index 176129fbd..f8743f007 100644 --- a/docs/tut_asterisk.rst +++ b/docs/tut_asterisk.rst @@ -8,7 +8,6 @@ In these tutorials we exemplify a few cases of integration between Asterisk_ and :maxdepth: 2 tut_asterisk_installs - tut_cgrates_installs tut_jitsi_installs tut_asterisk_ari tut_cgrates_usage diff --git a/docs/tut_asterisk_installs.rst b/docs/tut_asterisk_installs.rst index c1a4a48f7..29654ed0b 100644 --- a/docs/tut_asterisk_installs.rst +++ b/docs/tut_asterisk_installs.rst @@ -3,6 +3,12 @@ Software installation We have chosen Debian Jessie as operating system. +CGRateS +-------- + +**CGRateS** can be installed using the instructions found :ref:`here`. + + Asterisk_ --------- diff --git a/docs/tut_cgrates_installs.rst b/docs/tut_cgrates_installs.rst deleted file mode 100644 index 7f8b8f4aa..000000000 --- a/docs/tut_cgrates_installs.rst +++ /dev/null @@ -1,52 +0,0 @@ -**CGRateS** Installation -======================== - -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: - -- Git_ used by **CGRateS** History Server as archiver. -- Redis_ to serve as Rating and Accounting DB for **CGRateS**. -- MySQL_ to serve as StorDB for **CGRateS**. - -We will install them in one shot using the command bellow. - -:: - - apt-get install git redis-server mysql-server - -*Note*: We will use this MySQL_ root password when asked: *CGRateS.org*. - - -Installation ------------- - -Installation steps are provided within the **CGRateS** `install documentation `_. - -Since this tutorial is for master version of **CGRateS**, we will install CGRateS out of temporary .deb packages built out of master code: - -:: - - wget http://www.cgrates.org/tmp_pkg/cgrates_0.9.1~rc8_amd64.deb - dpkg -i cgrates_0.9.1~rc8_amd64.deb - -As described in post-install section, we will need to set up the MySQL_ database (using *CGRateS.org* as our root password): - -:: - - cd /usr/share/cgrates/storage/mysql/ - ./setup_cgr_db.sh root CGRateS.org localhost - -Once the database is in place, we can now set versions: -:: - - cgr-migrator -stordb_passwd="CGRateS.org" -exec="*set_versions" - -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/ diff --git a/docs/tut_freeswitch.rst b/docs/tut_freeswitch.rst index bcd6242e2..fcc293fd7 100644 --- a/docs/tut_freeswitch.rst +++ b/docs/tut_freeswitch.rst @@ -8,7 +8,6 @@ In these tutorials we exemplify a few cases of integration between FreeSWITCH_ a :maxdepth: 2 tut_freeswitch_installs - tut_cgrates_installs tut_jitsi_installs tut_freeswitch_json tut_cgrates_usage diff --git a/docs/tut_freeswitch_installs.rst b/docs/tut_freeswitch_installs.rst index 4ceca818d..f20d5f68c 100644 --- a/docs/tut_freeswitch_installs.rst +++ b/docs/tut_freeswitch_installs.rst @@ -3,6 +3,13 @@ Software installation As operating system we have chosen Debian Jessie, since all the software components we use provide packaging for it. +CGRateS +-------- + +**CGRateS** can be installed using the instructions found :ref:`here`. + + + FreeSWITCH_ ----------- diff --git a/docs/tut_kamailio.rst b/docs/tut_kamailio.rst index 4d955f647..bf3ca4947 100644 --- a/docs/tut_kamailio.rst +++ b/docs/tut_kamailio.rst @@ -8,7 +8,6 @@ In these tutorials we exemplify a few cases of integration between Kamailio_ and :maxdepth: 2 tut_kamailio_installs - tut_cgrates_installs tut_jitsi_installs tut_kamailio_evapi tut_cgrates_usage diff --git a/docs/tut_kamailio_installs.rst b/docs/tut_kamailio_installs.rst index 486bbda59..1a8c50960 100644 --- a/docs/tut_kamailio_installs.rst +++ b/docs/tut_kamailio_installs.rst @@ -3,6 +3,13 @@ Software installation We have chosen Debian Jessie as operating system, since all the software components we use provide packaging for it. +CGRateS +-------- + +**CGRateS** can be installed using the instructions found :ref:`here`. + + + Kamailio_ --------- diff --git a/docs/tut_opensips.rst b/docs/tut_opensips.rst index 01db8e291..e7c78ff9e 100644 --- a/docs/tut_opensips.rst +++ b/docs/tut_opensips.rst @@ -8,7 +8,6 @@ In these tutorials we exemplify a few cases of integration between OpenSIPS_ and :maxdepth: 2 tut_opensips_installs - tut_cgrates_installs tut_jitsi_installs tut_opensips_event tut_cgrates_usage diff --git a/docs/tut_opensips_installs.rst b/docs/tut_opensips_installs.rst index 95cc7d43d..70f193cff 100644 --- a/docs/tut_opensips_installs.rst +++ b/docs/tut_opensips_installs.rst @@ -3,6 +3,12 @@ Software installation We have chosen Debian Jessie as operating system, since all the software components we use provide packaging for it. +CGRateS +-------- + +**CGRateS** can be installed using the instructions found :ref:`here`. + + OpenSIPS_ ---------