Configuration
Introduction
The ANGEL APPLICATION will automatically create a configuration file with default values the first time it is run.
Of course, the simplest way to configure ANGEL APPLICATION is to use the preferences dialogue. If you want to see everything, you can also edit the config file using a text editor. This is described here.
Location
The configuration file can be found in your $HOME directory with the name '.angelrc'
/Users/bob/.angelrc
Opening and editing
The configuration file is a regular text-file, so any text-editor of your choice will be just fine. On Linux, this could be for example "Kate" or "vi", on Mac OS X, it could be the built-in application "TextEdit.app".
Syntax
The syntax of the configuration file is similar to the one of .ini files often found on Microsoft Windows. Basically, there are 'sections' and 'options' within 'sections'. A section is defined through a line containing a word in square brackets, an option by a word followed by an equal sign and a value:
[section] option = value
Available configuration options
[common] angelHome
Name of the directory for storing all things angel
[common] logdir
Name of the directory where the log-files should be stored
[common] repository
Name of the directory where the repository-files should be stored
[common] maxclones
How many clones should be kept/inspected for a given resource? (keep this low for maximum speed, raise it for maximum redundancy)
[common] loglevel
This specifies how noisy the logs will be (DEBUG, INFO, WARNING, ERROR, CRITICAL)
[common] desktopnotification
Boolean (True|False) to specify wether desktop notifications should be used (Growl on OS X)
[logfilters]
This is a special section which is empty by default. I can contain python module names as keys and set individual logging levels for each of them. The global loglevel specified in [common] still applies, so this is essentially only useful for silencing individual modules log-output. Example:
[logfilters]
master.angel_app.logserver = INFO
provider.angel_app.resource.local.renderManager = INFO
[dyndns]
An optional section dedicated to the built-in dynamic dns client. Possible option keys are: protocol, method, userid, password, key, hostname.
Option: protocol
There are different providers for this kind of service on the internet, which means that the correct combination of configuration options is a bit difficult to describe. The service provider is defined by the option 'protocol'.
Available protocols:
"majimoto" (for http://dyndns.majimoto.net/)
"dyndns" (for http://www.dyndns.com/)
If the protocol is not given, ANGEL defaults to dyndns.
Option: hostname
This option is required and specifies the DNS hostname that should be updated.
Option: method
This option selects the way the IP address shall be detected. Available values are:
"webcheck"
"teredoosx"
Option: userid
Required for protocol dyndns.
Option: password
Required for protocol dyndns.
Option: key
Required for protocol majimoto.
Option: sleeptime
This is optional and should only be needed if your IP address changes very slowly so you can increase the sleeptime between checks (specified in number of seconds).
Example:
[dyndns]
protocol = dyndns
userid = bob
password = s3cr3t
hostname = myhostname.dyndns.orgto be continued...