Configuration Files

This section describes some of the XiVO configuration files.

Configuration priority

Usually, the configuration is read from two locations: a configuration file config.yml and a configuration directory conf.d.

Files in the conf.d extra configuration directory are used in alphabetical order and the first one has priority. For example:

00-debug.yml:

debug: True

01-nodebug.yml:

debug: False

The value that will be used for debug will be True since 00-debug.yml comes before 01-nodebug.yml in the alphabetical order.

xivo-agentd

The configuration is done in the configuration directory. The configuration file should not be modified, because it will be overridden by upgrades.

  • Default configuration directory: /etc/xivo-agentd/conf.d
  • Default configuration file: /etc/xivo-agentd/config.yml

The configuration file may be used as an example for supported configuration file values.

See also Configuration priority.

xivo-auth

The configuration is done in the configuration directory. The configuration file should not be modified, because it will be overridden by upgrades.

  • Default configuration directory: /etc/xivo-auth/conf.d
  • Default configuration file: /etc/xivo-auth/config.yml

The configuration file may be used as an example for supported configuration file values.

See also Configuration priority.

xivo-ctid

The configuration is done in the configuration directory. The configuration file should not be modified, because it will be overridden by upgrades.

  • Default configuration directory: /etc/xivo-ctid/conf.d
  • Default configuration file: /etc/xivo-ctid/config.yml

The configuration file may be used as an example for supported configuration file values.

See Configuration priority.

xivo_ring.conf

  • Path: /etc/xivo/asterisk/xivo_ring.conf
  • Purpose: This file can be used to change the ringtone played by the phone depending on the origin of the call.

Warning

Note that this feature has not been tested for all phones and all call flows. This page describes how you can customize this file but does not intend to list all validated call flows or phones.

This file xivo_ring.conf consists of :

  • profiles of configuration (some examples for different brands are already included: [aastra], [snom] etc.)
  • one section named [number] where you apply the profile to an extension or a context etc.

Here is the process you should follow if you want to use/customize this feature :

  1. Create a new profile, e.g.:

    [myprofile-aastra]
    
  2. Change the phonetype accordingly, in our example:

    [myprofile-aastra]
    phonetype = aastra
    
  3. Chose the ringtone for the different type of calls (note that the ringtone names are brand-specific):

    [myprofile-aastra]
    phonetype = aastra
    intern = <Bellcore-dr1>
    group = <Bellcore-dr2>
    
  4. Apply your profile, in the section [number]

  • to a given list of extensions (e.g. 1001 and 1002):

    1001@default = myprofile-aastra
    1002@default = myprofile-aastra
    
  • or to a whole context (e.g. default):

    @default = myprofile-aastra
    
  1. Restart xivo-agid service:

    service xivo-agid restart
    

ipbx.ini

  • Path: /etc/xivo/web-interface/ipbx.ini
  • Purpose: This file specifies various configuration options and paths related to Asterisk and used by the web interface.

Here is a partial glimpse of what can be configured in file ipbx.ini :

  1. Enable/Disable modification of SIP line username and password:

    [user]
    readonly-idpwd = "true"
    
When editing a SIP line, the username and password fields cannot be modified via the web interface. Set this option to false to enable the modification of both fields. This option is set to “true” by default.

Warning

This feature is not fully tested. It should be used only when absolutely necessary and with great care.