config

Documentation

Index

• Constants
• func ConfigSlice(c *conf.ConfigFile, section, valName string) ([]string, error)
• func SetCgrConfig(cfg *CGRConfig)
• type CGRConfig
  • func CgrConfig() *CGRConfig
  • func NewCGRConfig(cfgPath *string) (*CGRConfig, error)
  • func NewCGRConfigBytes(data []byte) (*CGRConfig, error)
  • func NewDefaultCGRConfig() (*CGRConfig, error)

Constants

const (
	DISABLED = "disabled"
	INTERNAL = "internal"
	JSON     = "json"
	GOB      = "gob"
	POSTGRES = "postgres"
	MONGO    = "mongo"
	REDIS    = "redis"
	SAME     = "same"
	FS       = "freeswitch"
)

Functions

func ConfigSlice

func ConfigSlice(c *conf.ConfigFile, section, valName string) ([]string, error)

Adds support for slice values in config

func SetCgrConfig

func SetCgrConfig(cfg *CGRConfig)

Used to set system configuration from other places

Types

type CGRConfig

type CGRConfig struct {
	RatingDBType             string
	RatingDBHost             string // The host to connect to. Values that start with / are for UNIX domain sockets.
	RatingDBPort             string // The port to bind to.
	RatingDBName             string // The name of the database to connect to.
	RatingDBUser             string // The user to sign in as.
	RatingDBPass             string // The user's password.
	AccountDBType            string
	AccountDBHost            string // The host to connect to. Values that start with / are for UNIX domain sockets.
	AccountDBPort            string // The port to bind to.
	AccountDBName            string // The name of the database to connect to.
	AccountDBUser            string // The user to sign in as.
	AccountDBPass            string // The user's password.
	StorDBType               string // Should reflect the database type used to store logs
	StorDBHost               string // The host to connect to. Values that start with / are for UNIX domain sockets.
	StorDBPort               string // Th e port to bind to.
	StorDBName               string // The name of the database to connect to.
	StorDBUser               string // The user to sign in as.
	StorDBPass               string // The user's password.
	DBDataEncoding           string // The encoding used to store object data in strings: <msgpack|json>
	RPCEncoding              string // RPC encoding used on APIs: <gob|json>.
	DefaultReqType           string // Use this request type if not defined on top
	DefaultTOR               string // set default type of record
	DefaultTenant            string // set default tenant
	DefaultSubject           string // set default rating subject, useful in case of fallback
	RoundingMethod           string // Rounding method for the end price: <*up|*middle|*down>
	RoundingDecimals         int    // Number of decimals to round end prices at
	RaterEnabled             bool   // start standalone server (no balancer)
	RaterBalancer            string // balancer address host:port
	RaterListen              string // listening address host:port
	BalancerEnabled          bool
	BalancerListen           string // Json RPC server address
	SchedulerEnabled         bool
	CDRSEnabled              bool          // Enable CDR Server service
	CDRSListen               string        // CDRS's listening interface: <x.y.z.y:1234>.
	CDRSExtraFields          []string      //Extra fields to store in CDRs
	CDRSMediator             string        // Address where to reach the Mediator. Empty for disabling mediation. <""|internal>
	CdreCdrFormat            string        // Format of the exported CDRs. <csv>
	CdreExtraFields          []string      // Extra fields list to add in exported CDRs
	CdreDir                  string        // Path towards exported cdrs directory
	CdrcEnabled              bool          // Enable CDR client functionality
	CdrcCdrs                 string        // Address where to reach CDR server
	CdrcCdrsMethod           string        // Mechanism to use when posting CDRs on server  <http_cgr>
	CdrcRunDelay             time.Duration // Sleep interval between consecutive runs, if time unit missing, defaults to seconds, 0 to use automation via inotify
	CdrcCdrType              string        // CDR file format <csv>.
	CdrcCdrInDir             string        // Absolute path towards the directory where the CDRs are stored.
	CdrcCdrOutDir            string        // Absolute path towards the directory where processed CDRs will be moved.
	CdrcSourceId             string        // Tag identifying the source of the CDRs within CGRS database.
	CdrcAccIdField           string        // Accounting id field identifier. Use index number in case of .csv cdrs.
	CdrcReqTypeField         string        // Request type field identifier. Use index number in case of .csv cdrs.
	CdrcDirectionField       string        // Direction field identifier. Use index numbers in case of .csv cdrs.
	CdrcTenantField          string        // Tenant field identifier. Use index numbers in case of .csv cdrs.
	CdrcTorField             string        // Type of Record field identifier. Use index numbers in case of .csv cdrs.
	CdrcAccountField         string        // Account field identifier. Use index numbers in case of .csv cdrs.
	CdrcSubjectField         string        // Subject field identifier. Use index numbers in case of .csv CDRs.
	CdrcDestinationField     string        // Destination field identifier. Use index numbers in case of .csv cdrs.
	CdrcAnswerTimeField      string        // Answer time field identifier. Use index numbers in case of .csv cdrs.
	CdrcDurationField        string        // Duration field identifier. Use index numbers in case of .csv cdrs.
	CdrcExtraFields          []string      // Field identifiers of the fields to add in extra fields section, special format in case of .csv "field1:index1,field2:index2"
	SMEnabled                bool
	SMSwitchType             string
	SMRater                  string        // address where to access rater. Can be internal, direct rater address or the address of a balancer
	SMRaterReconnects        int           // Number of reconnect attempts to rater
	SMDebitInterval          int           // the period to be debited in advanced during a call (in seconds)
	SMMaxCallDuration        time.Duration // The maximum duration of a call
	MediatorEnabled          bool          // Starts Mediator service: <true|false>.
	MediatorListen           string        // Mediator's listening interface: <internal>.
	MediatorRater            string        // Address where to reach the Rater: <internal|x.y.z.y:1234>
	MediatorRaterReconnects  int           // Number of reconnects to rater before giving up.
	MediatorRunIds           []string      // Identifiers for each mediation run on CDRs
	MediatorReqTypeFields    []string      // Name of request type fields to be used during mediation. Use index number in case of .csv cdrs.
	MediatorDirectionFields  []string      // Name of direction fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorTenantFields     []string      // Name of tenant fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorTORFields        []string      // Name of tor fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorAccountFields    []string      // Name of account fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorSubjectFields    []string      // Name of subject fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorDestFields       []string      // Name of destination fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorAnswerTimeFields []string      // Name of time_start fields to be used during mediation. Use index numbers in case of .csv cdrs.
	MediatorDurationFields   []string      // Name of duration fields to be used during mediation. Use index numbers in case of .csv cdrs.
	FreeswitchServer         string        // freeswitch address host:port
	FreeswitchPass           string        // FS socket password
	FreeswitchReconnects     int           // number of times to attempt reconnect after connect fails
	HistoryAgentEnabled      bool          // Starts History as an agent: <true|false>.
	HistoryServer            string        // Address where to reach the master history server: <internal|x.y.z.y:1234>
	HistoryServerEnabled     bool          // Starts History as server: <true|false>.
	HistoryListen            string        // History server listening interface: <internal|x.y.z.y:1234>
	HistoryDir               string        // Location on disk where to store history files.
	HistorySaveInterval      time.Duration // The timout duration between history writes
}

Holds system configuration, defaults are overwritten with values from config file if found

func CgrConfig

func CgrConfig() *CGRConfig

Used to retrieve system configuration from other packages

func NewCGRConfig

func NewCGRConfig(cfgPath *string) (*CGRConfig, error)

Instantiate a new CGRConfig setting defaults or reading from file

func NewCGRConfigBytes

func NewCGRConfigBytes(data []byte) (*CGRConfig, error)

func NewDefaultCGRConfig

func NewDefaultCGRConfig() (*CGRConfig, error)