Installation

CGRateS can be installed either via packages or through an automated Go source installation. We recommend the latter for advanced users familiar with Go programming, and package installations for those not wanting to engage in the code building process.

After completing the installation, you need to perform the post-install configuration steps to set up CGRateS properly and prepare it to run. After these steps, CGRateS will be configured in /etc/cgrates/cgrates.json and the service can be managed using the systemctl command.

Package Installation 

Package installation method varies according to the Linux distribution:

Debian or Debian-based Distributions 

You can add the CGRateS repository to your system’s sources list, depending of the Debian version you are running, as follows:

# Install dependencies
sudo apt-get install wget gnupg -y

# Download and move the GPG Key to the trusted area
wget https://apt.cgrates.org/apt.cgrates.org.gpg.key -O apt.cgrates.org.asc
sudo mv apt.cgrates.org.asc /etc/apt/trusted.gpg.d/

# Add the repository to the apt sources list
echo "deb http://apt.cgrates.org/debian/ master-bookworm main" | sudo tee /etc/apt/sources.list.d/cgrates.list

# Update the system repository and install CGRateS
sudo apt-get update -y
sudo apt-get install cgrates -y

Alternatively, you can manually install a specific .deb package as follows:

wget http://pkg.cgrates.org/deb/master/bookworm/cgrates_current_amd64.deb
sudo dpkg -i ./cgrates_current_amd64.deb

# Install dependencies
sudo apt-get install wget gnupg -y

# Download and move the GPG Key to the trusted area
wget https://apt.cgrates.org/apt.cgrates.org.gpg.key -O apt.cgrates.org.asc
sudo mv apt.cgrates.org.asc /etc/apt/trusted.gpg.d/

# Add the repository to the apt sources list
echo "deb http://apt.cgrates.org/debian/ master-bullseye main" | sudo tee /etc/apt/sources.list.d/cgrates.list

# Update the system repository and install CGRateS
sudo apt-get update -y
sudo apt-get install cgrates -y

Alternatively, you can manually install a specific .deb package as follows:

wget http://pkg.cgrates.org/deb/master/bullseye/cgrates_current_amd64.deb
sudo dpkg -i ./cgrates_current_amd64.deb

Note

A complete archive of CGRateS packages is available at http://pkg.cgrates.org/deb/.

Redhat-based Distributions 

For .rpm distros, we are using copr to manage the CGRateS packages:

If using a version of Linux with dnf:

# sudo yum install -y dnf-plugins-core on RHEL 8 or CentOS Stream
sudo dnf install -y dnf-plugins-core
sudo dnf copr -y enable cgrates/master
sudo dnf install -y cgrates

For older distributions:

sudo yum install -y yum-plugin-copr
sudo yum copr -y enable cgrates/master
sudo yum install -y cgrates

To install a specific version of the package, run:

sudo dnf install -y cgrates-<version>.x86_64

Alternatively, you can manually install a specific .rpm package as follows:

wget http://pkg.cgrates.org/rpm/nightly/epel-9-x86_64/cgrates-current.rpm
sudo dnf install ./cgrates_current.rpm

Note

The entire archive of CGRateS rpm packages is available at https://copr.fedorainfracloud.org/coprs/cgrates/master/packages/ or http://pkg.cgrates.org/rpm/nightly/.

Installing from Source 

Prerequisites:

Git

sudo apt-get install -y git
# sudo dnf install -y git for .rpm distros

Go (refer to the official Go installation docs: https://go.dev/doc/install)

To install the latest Go version at the time of writing this documentation, run:

sudo apt-get install -y wget tar
# sudo dnf install -y wget tar for .rpm distros
sudo rm -rf /usr/local/go
cd /tmp
wget https://go.dev/dl/go1.24.2.linux-amd64.tar.gz
sudo tar -C /usr/local -xzf go1.24.2.linux-amd64.tar.gz
export PATH=$PATH:/usr/local/go/bin

Installation:

mkdir -p $HOME/go/src/github.com/cgrates/cgrates
git clone https://github.com/cgrates/cgrates.git $HOME/go/src/github.com/cgrates/cgrates
cd $HOME/go/src/github.com/cgrates/cgrates

# Compile the binaries and move them to $GOPATH/bin
./build.sh

# Create a symbolic link to the data folder
sudo ln -s $HOME/go/src/github.com/cgrates/cgrates/data /usr/share/cgrates

# Make cgr-engine binary available system-wide
sudo ln -s $HOME/go/bin/cgr-engine /usr/bin/cgr-engine

# Optional: Additional useful symbolic links
sudo ln -s $HOME/go/bin/cgr-loader /usr/bin/cgr-loader
sudo ln -s $HOME/go/bin/cgr-migrator /usr/bin/cgr-migrator
sudo ln -s $HOME/go/bin/cgr-console /usr/bin/cgr-console
sudo ln -s $HOME/go/bin/cgr-tester /usr/bin/cgr-tester

Installing Using Docker 

CGRateS is also available as Docker images.

Prerequisites 

Docker

Pull Docker Images 

The following commands will pull the CGRateS components:

sudo docker pull dkr.cgrates.org/master/cgr-engine
sudo docker pull dkr.cgrates.org/master/cgr-loader
sudo docker pull dkr.cgrates.org/master/cgr-migrator
sudo docker pull dkr.cgrates.org/master/cgr-console
sudo docker pull dkr.cgrates.org/master/cgr-tester

Verify the images were pulled successfully:

sudo docker images dkr.cgrates.org/master/cgr-*
REPOSITORY                           TAG       IMAGE ID       CREATED       SIZE
dkr.cgrates.org/master/cgr-loader    latest    5b667e92a475   6 weeks ago   46.5MB
dkr.cgrates.org/master/cgr-console   latest    464bd1992ab2   6 weeks ago   103MB
dkr.cgrates.org/master/cgr-engine    latest    e20f43491aa8   6 weeks ago   111MB
...

Note

While other version-specific tags are available, we recommend using the default latest tag for most use cases. You can check available versions with:

curl -X GET https://dkr.cgrates.org/v2/master/cgr-engine/tags/list

cgr-engine Container 

The current cgr-engine container entrypoint is:

[
  "/usr/bin/cgr-engine",
  "-logger=*stdout"
]

Note

Verify the entrypoint configuration with:

sudo docker inspect --format='{{json .Config.Entrypoint}}' dkr.cgrates.org/master/cgr-engine:latest

Running cgr-engine 

Here’s a basic example of running cgr-engine with common Docker parameters:

sudo docker run --rm \
  -v /path/on/host:/etc/cgrates \
  -p 2012:2012 \
  -e DOCKER_IP=127.0.0.1 \
  -e REDIS_HOST=192.168.122.91 \
  --network bridge \
  --name cgr-engine \
  dkr.cgrates.org/master/cgr-engine:latest \
  -config_path=/etc/cgrates \
  -logger=*stdout

Verify cgr-engine is responding:

sudo docker run --rm \
  --name cgr-console \
  --network host \
  dkr.cgrates.org/master/cgr-console:latest \
  status

Key parameters:

--rm: automatically remove container when it exits
-v: mount host directory into container (format: host_path:container_path)
-p: publish container port to host (format: host_port:container_port)
-e: set environment variables (optional, only needed if referenced in configuration files)
--network: specify container networking mode (bridge for isolation, host for direct host network access)
--name: assign name to container

Note

The -config_path and -logger flags above are cgr-engine specific flags and optional, as those values are already the defaults.

Creating Your Own Packages 

After compiling the source code, you may choose to create your own packages.

For Debian-based distros:

# Install dependencies
sudo apt-get install build-essential fakeroot dh-systemd -y

cd $HOME/go/src/github.com/cgrates/cgrates/packages

# Delete old ones, if any
rm -rf $HOME/go/src/github.com/cgrates/*.deb

make deb

Note

You might see some console warnings, which can be safely ignored.

To install the generated package, run:

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

For Redhat-based distros:

sudo dnf install -y rpm-build wget curl tar

# Create build directories
mkdir -p $HOME/rpmbuild/{BUILD,RPMS,SOURCES,SPECS,SRPMS}

# Fetch source code
cd $HOME/go/src/github.com/cgrates/cgrates
export gitLastCommit=$(git rev-parse HEAD)
export rpmTag=$(git log -1 --format=%ci | date +%Y%m%d%H%M%S)+$(git rev-parse --short HEAD)

#Create the tarball from the source code
cd ..
tar -czvf  $HOME/rpmbuild/SOURCES/$gitLastCommit.tar.gz cgrates

# Copy RPM spec file
cp $HOME/go/src/github.com/cgrates/cgrates/packages/redhat_fedora/cgrates.spec $HOME/rpmbuild/SPECS

# Build RPM package
cd $HOME/rpmbuild
rpmbuild -bb  SPECS/cgrates.spec

Post-install Configuration 

Database Setup 

CGRateS supports multiple database types for various operations, based on your installation and configuration.

Currently, we support the following databases:

Redis: This can be used as DataDB. It is optimized for real-time information access. Post-installation, no additional setup is required as Redis doesn’t require a specific schema.
MySQL: This can be used as StorDB and is optimized for CDR archiving and offline Tariff Plan versioning. Post-installation, you need to set up the CGRateS database using the provided scripts:

cd /usr/share/cgrates/storage/mysql/
sudo ./setup_cgr_db.sh root CGRateS.org localhost

PostgreSQL: Like MySQL, PostgreSQL can be used as StorDB. Post-installation, you need to set up the CGRateS database using the provided scripts:

cd /usr/share/cgrates/storage/postgres/
./setup_cgr_db.sh

MongoDB: MongoDB can be used as both DataDB and StorDB. This is the first database that can store all types of data from CGRateS - from accounts, tariff plans to CDRs and logs. Post-installation, you need to set up the CGRateS database using the provided scripts:

cd /usr/share/cgrates/storage/mongo/
./setup_cgr_db.sh

Set Versions Data 

After completing the database setup, you need to write the versions data. To do this, run the migrator tool with the parameters specific to your database.

Sample usage for MySQL:

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