diff options
| author | Stefan Hacker <dd0t@users.sourceforge.net> | 2012-12-09 00:10:04 +0400 |
|---|---|---|
| committer | Stefan Hacker <dd0t@users.sourceforge.net> | 2012-12-09 00:10:04 +0400 |
| commit | 9988e9a8a128f6207c935b33277e8b1993cea31f (patch) | |
| tree | 98001cee37eda5141a18b703cfbda4799d29c856 /scripts/murmur.ini | |
| parent | 8c07c7596f77754914d494c54a40ff0fa7c6f1cd (diff) | |
Improve murmur.ini documentation.
* Mention that values in there might be overridden with virtual server specific values
* Mention rules on value formating (no commas without quoting, escaping \ and so on)
Diffstat (limited to 'scripts/murmur.ini')
| -rw-r--r-- | scripts/murmur.ini | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/scripts/murmur.ini b/scripts/murmur.ini index 2b1586f9f..63bf35014 100644 --- a/scripts/murmur.ini +++ b/scripts/murmur.ini @@ -1,3 +1,16 @@ +# murmur configuration file. +# +# General notes: +# * Settings in this file are default settings and many of the can be overridden +# with virtual server specific configuration via the Ice or DBus interface. +# * Due to the way this configuration file is read some rules have to be +# followed when specifying variable values (as in variable = value): +# * Make sure to quote the value when using commas in strings or passwords. +# NOT variable = super,secret BUT variable = "super,secret" +# * Make sure to escape special characters like '\' or '"' correctly +# NOT variable = """ BUT variable = "\"" +# NOT regex = \w* BUT regex = \\w* + # Path to database. If blank, will search for # murmur.sqlite in default locations or create it if not found. database= |