Difference between revisions of "Remote.conf file"
From AMule Project FAQ
GonoszTopi (Talk | contribs) |
m (→Example) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
== File == | == File == | ||
| − | |||
'''Name:''' ''remote.conf'' | '''Name:''' ''remote.conf'' | ||
| Line 6: | Line 5: | ||
== Description == | == Description == | ||
| + | This is the common configuration [[aMule_files|file]] for all remote tools ([[aMuleCMD]], [[aMuleWeb]], [[aMuleGUI|remote gui]]). The above mentioned name and location is the default name and location for this file, but, unlike all other config files, they can be changed via the ''-f'' (''--config-file'') command-line parameter. | ||
| − | + | '''Note''': command-line switches and parameters apply only to aMuleCmd and aMuleWeb. aMule remote GUI does not yet implement them. | |
| − | + | ||
| − | '''Note''': | + | |
== Format == | == Format == | ||
| − | |||
This is a text file, in the format of the [http://www.microsoft.com/windows Windows] .INI files. | This is a text file, in the format of the [http://www.microsoft.com/windows Windows] .INI files. | ||
| Line 20: | Line 17: | ||
== Keys description == | == Keys description == | ||
| − | |||
=== General notes === | === General notes === | ||
| − | + | *For keys that accept an [http://en.wikipedia.org/wiki/MD5 MD5] [[hash]], the value is always case insensitive. | |
| − | *For keys that accept an [http://en.wikipedia.org/wiki/MD5 MD5] hash, the value is always case insensitive. | + | |
*For keys that enable/disable something (or at least have a boolean type value), '0' means 'false' or 'disabled', '1' means 'true' or 'enabled'. | *For keys that enable/disable something (or at least have a boolean type value), '0' means 'false' or 'disabled', '1' means 'true' or 'enabled'. | ||
=== Common keys === | === Common keys === | ||
| − | |||
; '''/Locale''' : Selects language that remote tools should use. Possible values are the language codes for the given language, such as ''de'', ''en_GB''; or the proper english name of the language, e.g. ''french''. Defaults to an empty value, which means '' 'use system default language' ''. Can be overridden by the ''-l'' (''--locale'') command-line parameter. | ; '''/Locale''' : Selects language that remote tools should use. Possible values are the language codes for the given language, such as ''de'', ''en_GB''; or the proper english name of the language, e.g. ''french''. Defaults to an empty value, which means '' 'use system default language' ''. Can be overridden by the ''-l'' (''--locale'') command-line parameter. | ||
| − | ; '''/EC/Host''' : Hostname or IP address of the remote running core ([[aMule]] or [[aMuled]]). Defaults to '' 'localhost' ''. Can be overridden by the ''-h'' (''--host'') command-line parameter. | + | ; '''/EC/Host''' : Hostname or [[IP address|IP]] address of the remote running core ([[aMule]] or [[aMuled]]). Defaults to '' 'localhost' ''. Can be overridden by the ''-h'' (''--host'') command-line parameter. |
| − | ; '''/EC/Port''' : Port number where remote core listens to | + | ; '''/EC/Port''' : [[Port]] number where remote core listens to [[External Connections]] (EC). Defaults to '' '4712' ''. Can be overridden by the ''-p'' (''--port'') command-line parameter. |
| − | ; '''/EC/Password''' : MD5 hash of the password used for EC | + | ; '''/EC/Password''' : MD5 hash of the password used for EC [[connect]]ion. Can be overridden by the ''-P'' (''--password'') command-line parameter, which accepts a plain-text password! |
=== Keys specific to aMuleCmd === | === Keys specific to aMuleCmd === | ||
| − | |||
None. | None. | ||
=== Keys specific to aMuleWeb === | === Keys specific to aMuleWeb === | ||
| − | |||
; '''/Webserver/Port''' : Port number, where aMuleWeb listens for connections from browsers. Defaults to '' '-1' '', which means '' 'query from remote core' ''. If query fails for some reason, '' '4711' '' will be used, but aMuleWeb will most likely be unusable (if such a simple query fails, what to expect from more complex queries?). Can be overridden by the ''-s'' (''--server-port'') command-line parameter. | ; '''/Webserver/Port''' : Port number, where aMuleWeb listens for connections from browsers. Defaults to '' '-1' '', which means '' 'query from remote core' ''. If query fails for some reason, '' '4711' '' will be used, but aMuleWeb will most likely be unusable (if such a simple query fails, what to expect from more complex queries?). Can be overridden by the ''-s'' (''--server-port'') command-line parameter. | ||
| Line 63: | Line 55: | ||
=== Keys specific to Remote GUI === | === Keys specific to Remote GUI === | ||
| − | + | Remote GUI currently messes up remote.conf, saves a lot of irrelevant keys and does not save some important ones. When this will be fixed, I'll describe its keys too.<br/> | |
| − | Remote GUI currently messes up remote.conf, saves a lot of irrelevant keys and does not save some important ones. When this will be fixed, I'll describe its keys too. | + | |
== Example == | == Example == | ||
| − | + | The example below shows a default ''remote.conf'' file, with the exception of the EC password, which is set to dummy (but valid) value. | |
| − | The example below shows a default remote.conf file, with the exception of the EC password, which is set to dummy (but valid) value. | + | |
Locale= | Locale= | ||
| Line 86: | Line 76: | ||
GraphWidth=500 | GraphWidth=500 | ||
GraphScale=3 | GraphScale=3 | ||
| + | |||
| + | |||
| + | |||
| + | [[Category:Program Files]] | ||
Latest revision as of 12:04, 20 June 2012
Contents
File
Name: remote.conf
Location: ~/.aMule/
Description
This is the common configuration file for all remote tools (aMuleCMD, aMuleWeb, remote gui). The above mentioned name and location is the default name and location for this file, but, unlike all other config files, they can be changed via the -f (--config-file) command-line parameter.
Note: command-line switches and parameters apply only to aMuleCmd and aMuleWeb. aMule remote GUI does not yet implement them.
Format
This is a text file, in the format of the Windows .INI files.
In the file, configuration options are set in key-value pairs. Each line contains exactly one key-value pair, in the form of <key>=<value> (except for group headers and comments, see below). Keys are organized into groups, and even groups may have sub-groups. Any line starting with a ';' (semicolon) character is considered to be a comment. Comments and empty lines are ignored. Group headers are in the form '['<group name>']'.
Keys are referenced as if they were files in a file system where directories are the groups. For example, the key 'Password' in the group 'EC' is referenced as '/EC/Password' . Hopefully the following descriptions and the example will make it clear.
Keys description
General notes
- For keys that accept an MD5 hash, the value is always case insensitive.
- For keys that enable/disable something (or at least have a boolean type value), '0' means 'false' or 'disabled', '1' means 'true' or 'enabled'.
Common keys
- /Locale
- Selects language that remote tools should use. Possible values are the language codes for the given language, such as de, en_GB; or the proper english name of the language, e.g. french. Defaults to an empty value, which means 'use system default language' . Can be overridden by the -l (--locale) command-line parameter.
- /EC/Host
- Hostname or IP address of the remote running core (aMule or aMuled). Defaults to 'localhost' . Can be overridden by the -h (--host) command-line parameter.
- /EC/Port
- Port number where remote core listens to External Connections (EC). Defaults to '4712' . Can be overridden by the -p (--port) command-line parameter.
- /EC/Password
- MD5 hash of the password used for EC connection. Can be overridden by the -P (--password) command-line parameter, which accepts a plain-text password!
Keys specific to aMuleCmd
None.
Keys specific to aMuleWeb
- /Webserver/Port
- Port number, where aMuleWeb listens for connections from browsers. Defaults to '-1' , which means 'query from remote core' . If query fails for some reason, '4711' will be used, but aMuleWeb will most likely be unusable (if such a simple query fails, what to expect from more complex queries?). Can be overridden by the -s (--server-port) command-line parameter.
- /Webserver/Template
- Name of the web template to use. Defaults to 'default' . The current version of aMuleWeb installs one another template, named 'chicane' . Can be overridden by the -t (--template) command-line parameter.
- /Webserver/UseGzip
- Enables or disables gzip compression of HTML pages. Defaults to disabled. Can be overridden by the -z (--enable-gzip) or -Z (--disable-gzip) command-line switches.
- /Webserver/AllowGuest
- Enables or disables guest mode logins to the web interface. Defaults to disabled. Can be overridden by the -a (--allow-guest) or -d (--deny--guest) command-line switches.
- /Webserver/AdminPassword
- MD5 password for admin login. Can be overridden by the -A (--admin-pass) command-line parameter, which accepts a plain-text password!
- /Webserver/GuestPassword
- MD5 password for guest login. Makes sense only when guest login is enabled. Can be overridden by the -G (--guest-pass) command-line parameter, which accepts a plain-text password!
- /Webserver/PageRefreshTime
- Time interval in seconds between page reloads. '0' means 'page refresh disabled' . Defaults to '120' , i.e. 2 minutes.
- /Webserver/GraphHeight
- Height (in pixels) of the statistics graphs. Default is '149' .
- /Webserver/GraphWidth
- Width (in pixels) of the statistics graphs. Default is '500' .
- /Webserver/GraphScale
- Scaling of the statistics graphs. This means 'each pixel in the graph represents 'x' seconds' . Default is 3 seconds/pixel.
Keys specific to Remote GUI
Remote GUI currently messes up remote.conf, saves a lot of irrelevant keys and does not save some important ones. When this will be fixed, I'll describe its keys too.
Example
The example below shows a default remote.conf file, with the exception of the EC password, which is set to dummy (but valid) value.
Locale= [EC] Host=localhost Port=4712 Password=5D41402ABC4B2A76B9719D911017C592 [Webserver] Port=-1 Template=default UseGzip=0 AllowGuest=0 AdminPassword= GuestPassword= PageRefreshTime=120 GraphHeight=149 GraphWidth=500 GraphScale=3
