SipXphone Configuration Files
From SIPfoundry sipx, The Open Source SIP PBX for Linux - Calivia
sipXphone Configuration Files
Note: Understanding and using the sipXphone configuration files is optional and is only recommended for advanced users. The sipXphone Web UI allows the definition of all necessary parameters and represents a GUI based approach to configuring sipXphone. The configuration created with the Web UI is then safed in specific text based configuration files as described on this page. In Windows the location of these files is:
| File: Location of configuration files |
\Program Files\SIPfoundry\sipxphone\meta |
Regardless of which interface you use to configure a sipXphone, the phone stores its configuration data in the pinger-config and user-config text files. At startup, sipXphone searches its file system for both of these files. If either file is not present, the phone creates that file with default configuration data automatically.
In addition, the file local-config stores the phone's serial number, a re-start counter, as well as a the parameter for manual discovery of the sipX Config Server host.
Formatting requirements
Formatting requirements for the user-config, pinger-config and local-config files are as follows:
Parameter name : value format
When you add a parameter and value to a config file, the spacing and punctuation that you use are important. Enter the complete parameter name, a space, a colon, another space, and then the value. For example:
PHONESET_BUSY_BEHAVIOR : BUSY
Expected format for values
Some parameters require a specific format when you supply a value. For example, when you enter the address of a SIP server, be sure to use the format sip:<fully qualified host name> for that value. The description of each parameter supplies applicable formatting information.
Parameters with specific valid values
Some parameters accept only a limited set of valid values. For example, BUSY and FORWARD are the only valid values for the PHONESET_BUSY_BEHAVIOR parameter. When you manually edit the pinger-config or user-config file, be sure to supply only a valid value. Descriptions for parameters with this requirement include all of the valid values. If you enter an invalid value in pinger-config or user-config, the phone uses the default value for that parameter.
Parameters that store more than one value
Most configuration parameters store only one value and appear in a config file only once. Some parameters, however, can store multiple values; others can be added to a configuration file more than once and store different values for use in different situations. Parameter descriptions indicate whether multiple values can be saved and include specific formatting rules.
Exceptions
You can set most parameters by manually editing pinger-config or user-config. The exceptions are:
- Set PHONESET_HTTP_PORT: This parameter enables and disables Web access to sipXphone.
- Set up user names and passwords: The browser-based interface automatically encrypts passwords stored for PHONESET_HTTP_AUTH_DB. (You can use either the browser-based interface or the phone top to change the password for the admin user.)
- Set up user lines: The browser-based interface automatically numbers each user line, and groups all of the parameters for a line together by adding that number to the name of each parameter.
- Set up authentication for outbound calling: The browser-based interface automatically encrypts authentication passwords.
Parameters accessible with the Web-based UI
Not all parameters have a graphic representation in the phone's Web-based UI. However, under the tab Administration and Phone Configuration the UI provides a box for additional parameters. Any parameters not represented in the graphical section of the UI can be added here and will be included in the phone's configuration. Therefore, there is no need to directly edit any of the configuration files ever.
Encrypting configuration files when using the sipX Configuration Server
Note: For sipXphone softphones managed by a sipX IP phone system, the ENCRYPT_PROFILES parameter can be set to encrypt the pinger-config and user-config files. When this parameter is enabled, these files cannot be edited manually, even on a temporary basis.
Default local-config file
By default, the local-config file of a sipXphone contains: SERIAL_NUMBER : xx-xx-xx-xx-xx-xx LOCAL_RESTART_COUNTER : x
The serial number is the MAC address of the PC interface card used.
Optional parameters: CONFIG_ENROLLMENT_HOST : host.domain.com
If the name sipuaconfig cannot be defined in the DNS server as an alias that points to the sipX host, the correct host name for the sipX server can be manually configured here. If you are not using the sipX Configuration Server to configure sipXphone you can ignore this parameter.
Default pinger-config file
By default, the pinger-config file of a sipXphone contains: PHONESET_AVAILABLE_BEHAVIOR : RING PHONESET_BUSY_BEHAVIOR : BUSY PHONESET_CALL_WAITING_BEHAVIOR : ALERT PHONESET_DIALPLAN_LENGTH : 4 PHONESET_DND_METHOD : FORWARD_ON_BUSY PHONESET_FORWARD_UNCONDITIONAL : DISABLE PHONESET_LINE.ALLOW_FORWARDING : ENABLE PHONESET_LINE.REGISTRATION : PROVISION PHONESET_LINE.URL : sip:4444@ PHONESET_RINGER : BOTH PHONESET_RTP_PORT_START : 8766 PHONESET_TIME_DST_RULE : PHONESET_TIME_OFFSET : SIP_AUTHENTICATE_REALM : SIP_AUTHENTICATE_SCHEME : SIP_DIRECTORY_SERVERS : SIP_FORWARD_ON_BUSY : SIP_FORWARD_ON_NO_ANSWER : SIP_FORWARD_UNCONDITIONAL : SIP_PROXY_SERVERS : SIP_REGISTER_PERIOD : 3600 SIP_SESSION_REINVITE_TIMER : SIP_TCP_PORT : 5060 SIP_UDP_PORT : 5060
Default user-config file
By default, the user-config file for a sipXphone contains these parameters, including the admin user name and its default, encrypted password:
PHONESET_HTTP_AUTH_DB.admin: cc3779c1114ba5fd9882afdc7ef267e3 USER_DEFAULT_OUTBOUND_LINE : PHONESET_LINE
After user preferences are set for a phone, its user-config file contains additional parameters and values.
Effect of using the browser-based interface: If you make changes to a phone's configuration with the browser-based interface, it redistributes parameters among the pinger-config and user-config files. The browser-based interface saves these parameters in pinger-config:
PHONESET_ADMIN_DOMAIN PHONESET_DEPLOYMENT_SERVER PHONESET_DIALPLAN_LENGTH PHONESET_EXTERNAL_IP_ADDRESS PHONESET_LINE.ALLOW_FORWARDING PHONESET_LINE.CREDENTIAL.<n>.PASSTOKEN PHONESET_LINE.CREDENTIAL.<n>.REALM PHONESET_LINE.CREDENTIAL.<n>.USERID PHONESET_LINE.REGISTRATION PHONESET_LINE.URL PHONESET_LOGICAL_ID PHONESET_RTP_PORT_START PHONESET_VERSIONCHECK_PERIOD PHONESET_VERSIONCHECK_URL SIP_DIRECTORY_SERVERS SIP_PROXY_SERVERS SIP_REGISTER_PERIOD SIP_SESSION_REINVITE_TIMER SIP_TCP_PORT SIP_UDP_PORT
The browser-based interface saves these parameters in user-config:
ALLOW_CONSOLE_OUTPUT JAVA_OUTPUTSTREAM_REDIRECT PHONESET_AVAILABLE_BEHAVIOR PHONESET_BUSY_BEHAVIOR PHONESET_CALL_WAITING_BEHAVIOR PHONESET_DIGITMAP PHONESET_DND PHONESET_DND_METHOD PHONESET_FORWARD_UNCONDITIONAL PHONESET_HTTP_AUTH_DB PHONESET_HTTP_PORT PHONESET_HTTP_PROXY_HOST PHONESET_HTTP_PROXY_PORT PHONESET_LOGO_URL PHONESET_MSG_WAITING_SUBSCRIBE PHONESET_NO_ANSWER_TIMEOUT PHONESET_RINGER PHONESET_SNMP_TRAP_DESTS PHONESET_TELNET_ACCESS PHONESET_TIME_DST_RULE PHONESET_TIME_OFFSET PHONESET_TIME_SERVER PHONESET_VOICEMAIL_RETRIEVE SIP_AUTHENTICATE_DB SIP_AUTHENTICATE_REALM SIP_AUTHENTICATE_SCHEME SIP_FORWARD_ON_BUSY SIP_FORWARD_ON_NO_ANSWER SIP_FORWARD_UNCONDITIONAL USER_DEFAULT_OUTBOUND_LINE USER_LINE.<n>.ALLOW_FORWARDING USER_LINE.<n>.CREDENTIAL.<n>.PASSTOKEN USER_LINE.<n>.CREDENTIAL.<n>.REALM USER_LINE.<n>.CREDENTIAL.<n>.USERID USER_LINE.<n>.REGISTRATION USER_LINE.<n>.URL
Tip: Values in the user-config file override values in the pinger-config file.
