Configuration Files
| 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=== | === Structure of configuration files=== | ||
| Line 16: | 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'''". | ||
| + | |||
| + | Comments are the lines starting with ''';'''. | ||
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 | 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 | ||
| Line 21: | Line 24: | ||
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 files location === | ||
| + | |||
| + | The configuration files are in conf.d directory that is in found in the directory where you build Yate. | ||
| + | |||
| + | More informations about the path for configuration files in function of how Yate was installed and the operation file you can find in [[Paths and Directories]] page. | ||
=== Configuration options=== | === Configuration options=== | ||
Revision as of 17:40, 11 January 2013
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".
Comments are the lines starting with ;.
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 files location
The configuration files are in conf.d directory that is in found in the directory where you build Yate.
More informations about the path for configuration files in function of how Yate was installed and the operation file you can find in Paths and Directories page.
Configuration options
See modules and features documentation for other configuration options.
See also
