CGRateS Documentation

Welcome to CGRateS’s documentation!

CGRateS is a very fast (50k+ CPS) and easily scalable (load-balancer + replication included) Real-time Enterprise Billing Suite targeted especially for ISPs and Telecom Operators (but not only).

• Overview
  • Features
  • Links
  • License
• Architecture
  • cgr-engine
    • Agents
      • DiameterAgent
      • RadiusAgent
      • HTTPAgent
      • DNSAgent
      • AsteriskAgent
      • FreeSWITCHAgent
      • KamailioAgent
      • EventReaderService
    • SessionS
      • Parameters
      • Processing logic
    • RALs
      • Rating
      • Accounting
      • ActionTrigger
      • Action
      • Configuration
      • Use cases
    • CDRs
      • Parameters
      • APIs logic
      • Use cases
    • CDRe
      • Export types
      • Parameters
    • AttributeS
      • Selection
      • Parameters
      • Use cases
    • ChargerS
      • DerivedCharging
      • Processing logic
      • Parameters
      • Use cases
    • ResourceS
      • Parameters
      • Processing logic
      • Use cases
    • RouteS
      • Processing logic
      • APIs logic
      • Parameters
      • Use cases
    • StatS
      • Processing logic
      • Parameters
      • Use cases
    • ThresholdS
      • Processing logic
      • APIs logic
      • Parameters
      • Use cases
    • FilterS
      • Filter profile
      • Filter rule
      • Inline Filter
      • Subsystem profiles selection based on Filters
    • DispatcherS
    • SchedulerS
    • APIerS
    • LoaderS
    • CacheS
    • DataDB
    • StorDB
  • cgr-console
  • cgr-loader
  • cgr-migrator
  • cgr-tester
• Installation
  • Using packages
    • Debian
      • Aptitude repository
      • Manual installation of .deb package out of archive server
    • Redhat/Fedora/CentOS
      • YUM repository
      • Manual installation of .rpm package out of archive server
  • Using source
    • Install GO Lang
    • Build CGRateS from Source
    • Create Debian / Ubuntu Packages from Source
    • Install Custom Debian / Ubuntu Package
    • Generate RPM Packages from Source
  • Post-install
    • Database setup
    • Set versions data
• Configuration
• Administration
• Advanced Topics
  • API Calls
  • Rating logic
    • User balances
• Tutorials
  • Asterisk Integration Tutorials
    • Software installation
      • CGRateS
      • Asterisk
    • SIP UA - Jitsi
    • Asterisk interaction via ARI
      • Scenario
      • Starting Asterisk with custom configuration
      • Starting CGRateS with custom configuration
      • CDR processing
      • CGRateS Usage
    • CGRateS Usage
      • Loading CGRateS Tariff Plans
      • Test calls
      • CDR Exporting
      • Fraud detection
  • FreeSWITCH Integration Tutorials
    • Software Installation
      • CGRateS
      • FreeSWITCH
    • SIP UA - Jitsi
    • FreeSWITCH generating http-json CDRs
      • Scenario
      • Starting FreeSWITCH with custom configuration
      • Starting CGRateS with custom configuration
      • CDR processing
      • CGRateS Usage
    • CGRateS Usage
      • Loading CGRateS Tariff Plans
      • Test calls
      • CDR Exporting
      • Fraud detection
  • Kamailio Integration Tutorials
    • Software installation
      • CGRateS
      • Kamailio
    • SIP UA - Jitsi
    • Kamailio interaction via evapi module
      • Scenario
      • Starting Kamailio with custom configuration
      • Starting CGRateS with custom configuration
      • CDR processing
      • CGRateS Usage
    • CGRateS Usage
      • Loading CGRateS Tariff Plans
      • Test calls
      • CDR Exporting
      • Fraud detection
  • OpenSIPS Integration Tutorials
    • Software installation
      • CGRateS
      • OpenSIPS
    • SIP UA - Jitsi
    • OpenSIPS interaction via event_datagram
      • Scenario
      • Starting OpenSIPS with custom configuration
      • Starting CGRateS with custom configuration
      • CDR processing
      • CGRateS Usage
    • CGRateS Usage
      • Loading CGRateS Tariff Plans
      • Test calls
      • CDR Exporting
      • Fraud detection
• Troubleshooting
  • Memory Profiling
    • Creating the memory profile files
    • Reading the memory profile files
• Miscellaneous
  • FreeSWITCH integration
    • SessionManager