Configuration Files

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
  
 
The main yate startup configuration is stored in the file "yate.conf". ''Please notice that "yate.conf" under Windows has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version''. In other words '''it has to match the executable file name or the file would not be loaded''' and default configuration will be applied.
 
The main yate startup configuration is stored in the file "yate.conf". ''Please notice that "yate.conf" under Windows has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version''. In other words '''it has to match the executable file name or the file would not be loaded''' and default configuration will be applied.
 +
 +
=== Structure of configuration files===
  
 
The structure of the configuration files is similar to the Windows INI files. They are text files divided in sections each containing several key=value pairs:
 
The structure of the configuration files is similar to the Windows INI files. They are text files divided in sections each containing several key=value pairs:
Line 15: Line 17:
 
Spaces surrounding section, keys and values are removed - in the example above the 2nd pair in section1 has key "'''key2'''" and value "'''value 2'''".
 
Spaces surrounding section, keys and values are removed - in the example above the 2nd pair in section1 has key "'''key2'''" and value "'''value 2'''".
  
Starting with SVN Rev. 2433 (2009-01-13) very long values (like database queries) can be broken over several lines by placing a backslash at the end of line. In the example above "'''key'''" will have a value of "'''A very long value that continues over several lines'''" - note that spaces at start of continuation lines are also removed.
+
Starting with '''SVN Rev. 2433''' (2009-01-13) very long values (like database queries) can be broken over several lines by placing a backslash at the end of line. In the example above  
 +
'''key'''" will have a value of "'''A very long value that continues over several lines'''" - note that spaces at start of continuation lines are also removed.
  
 
If you need to have a backslash at the end of a value just add one or more white spaces (blank or tab) after it.
 
If you need to have a backslash at the end of a value just add one or more white spaces (blank or tab) after it.
 +
 +
=== Configuration options===
  
 
See [[Modules|modules and features documentation]] for other configuration options.
 
See [[Modules|modules and features documentation]] for other configuration options.
 +
 +
 +
'''See also'''
 +
 +
* [[Telephony]]

Revision as of 14:54, 12 December 2012

The main yate startup configuration is stored in the file "yate.conf". Please notice that "yate.conf" under Windows has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version. In other words it has to match the executable file name or the file would not be loaded and default configuration will be applied.

Structure of configuration files

The structure of the configuration files is similar to the Windows INI files. They are text files divided in sections each containing several key=value pairs:

[section1]
key1=value 1
 key2 = value 2

[section2]
key = A very long value \
that continues over \
several lines

Spaces surrounding section, keys and values are removed - in the example above the 2nd pair in section1 has key "key2" and value "value 2".

Starting with SVN Rev. 2433 (2009-01-13) very long values (like database queries) can be broken over several lines by placing a backslash at the end of line. In the example above 
key" will have a value of "A very long value that continues over several lines" - note that spaces at start of continuation lines are also removed.

If you need to have a backslash at the end of a value just add one or more white spaces (blank or tab) after it.

Configuration options

See modules and features documentation for other configuration options.


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers