3. Installation

CGRateS can be installed via packages as well as Go automated source install. We recommend using source installs for advanced users familiar with Go programming and packages for users not willing to be involved in the code building process.

3.1. Using packages

3.1.1. Debian

This is for the moment the only packaged and the most recommended to use method to install CGRateS.

On the server you want to install CGRateS, simply execute the following commands:

wget http://www.cgrates.org/tmp_pkg/cgrates_0.9.1~rc8_amd64.deb
dpkg -i cgrates_0.9.1~rc8_amd64.deb

Once the installation is completed, one should perform the 3.2.3 Create Debian / Ubuntu Packages from Source section in order to have the CGRateS properly set and ready to run. After post-install actions are performed, CGRateS will be configured in /etc/cgrates/cgrates.json and enabled in /etc/default/cgrates.

3.2. Using source

For developing CGRateS and switching between its versions, we are using the new vendor directory feature introduced in go 1.6. In a nutshell all the dependencies are installed and used from a folder named vendor placed in the root of the project.

3.2.1 Install GO Lang

First we have to setup the GO Lang to our OS. Feel free to download the latest GO binary release from https://golang.org/dl/ In this Tutorial we are going to install Go 1.11

rm -rf /usr/local/go
cd /tmp
wget https://dl.google.com/go/go1.11.linux-amd64.tar.gz
sudo tar -xvf go1.11.0.linux-amd64.tar.gz -C /usr/local/
export PATH=$PATH:/usr/local/go/bin:$GOPATH/bin

3.2.2 Build CGRateS from Source

To manage this vendor folder we use a tool named glide which will download specific versions of the external packages used by CGRateS. To configure the project with glide use the following commands:

go get github.com/Masterminds/glide
go get github.com/cgrates/cgrates
cd $GOPATH/src/github.com/cgrates/cgrates
glide install
./build.sh

The glide install command will install the external dependencies versions, specified in the glide.lock file, in the vendor folder. There are different versions for each CGRateS branch, versions that are recorded in the lock file when the GCRateS releases are made (using glide update command).

Note

The vendor folder should not be registered with the VCS we are using.

For more information and command options use glide readme page.

3.2.3 Create Debian / Ubuntu Packages from Source

After compiling the source code you are ready to create the .deb packages for your Debian like OS. But First lets install some dependencies.

sudo apt-get install build-essential fakeroot dh-systemd

Finally we are ready to create the system package. Before creation we make sure that we delete the old one first.

cd $GOPATH/src/github.com/cgrates/cgrates/packages
rm -rf $GOPATH/src/github.com/cgrates/*.deb
make deb

After some time and maybe some console warnings, your CGRateS package will be ready.

3.2.4 Install Custom Debian / Ubuntu Package

cd $GOPATH/src/github.com/cgrates
sudo dpkg -i cgrates_*.deb

3.3. Post-install

3.3.1. Database setup

For its operation CGRateS uses one or more database types, depending on its nature, install and configuration being further necessary.

At present we support the following databases:

Can be used as data_db . Optimized for real-time information access. Once installed there should be no special requirements in terms of setup since no schema is necessary.

Can be used as stor_db . Optimized for CDR archiving and offline Tariff Plan versioning. Once MySQL 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/mysql/
./setup_cgr_db.sh root CGRateS.org localhost

Can be used as stor_db . Optimized for CDR archiving and offline Tariff Plan versioning. Once PostgreSQL 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

Can be used as data_db - stor_db . It is the first database that can be used to store all kinds of data stored from CGRateS from accounts, tariff plans to cdrs and logs. This is provided as an alternative to Redis and/or MySQL/PostgreSQL and right now there are NO plans to drop support for any of them soon.

Once MongoDB 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/mongo/
./setup_cgr_db.sh

3.3.2 Set versions data

Once database setup is completed, we need to write the versions data. To do this, run migrator tool with the parameters specific to your database.

Sample usage for MySQL:

cgr-migrator -stordb_passwd="CGRateS.org" -migrate="*set_versions"

3.3.3.Git

The historys (History Service) component will use Git to archive tariff plan changes in a local repository, hence Git installation is necessary if you want to use this service.