AMule Project FAQ - User contributions [en]

Remote.conf file

2007-12-18T16:00:27Z

Felipe1982: /* Keys specific to Remote GUI */

== File ==

'''Name:''' ''remote.conf''

'''Location:''' ''~/.aMule/''

== 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.

== Format ==

This is a text file, in the format of the [http://www.microsoft.com/windows 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 [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'.

=== 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 [[connect]]ion. 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 [http://www.gzip.org/ gzip] compression of [http://www.w3.org/MarkUp/ 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. 
'''Is this still true? --[[User:Felipe1982|Felipe1982]]'''

== 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

HowTo Compile aMuled

2007-12-14T06:32:38Z

Felipe1982: /* 2nd */

<center> '''English''' | [[HowTo_Compile_aMuled-es|Español]] | [[HowTo_Compile_aMuled-nl|Nederlands]] | [[HowTo Compile aMuled-fr|Français]] | [[HowTo Compile aMuled-de|Deutsch]]</center>

== 1st ==

'''NOTE 1:''' In order to compile aMule 2.2.0 or higher you need wx 2.8.x.

'''NOTE 2:''' In order to compile aMule 2.1.3 with wx-2.8.x you need a Patch available [http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/aMule-wx.patch?rev=1.2 here]

'''NOTE 3:''' I had success with [http://www.wxwidgets.org/downloads/ wxall] (a.k.a. wxWidgets) instead of using wxBase --[[User:Felipe1982|Felipe1982]] 06:21, 14 December 2007 (UTC)

Download [[wxBase]] 2.8.1 or higher from http://www.wxWidgets.org
unpack it, and do as user
*''./configure --disable-gui --enable-unicode --without-subdirs --without-expat
*''make''
as root
*''make install''
*''ldconfig''

== 2nd ==
[http://www.amule.org/files/files.php?cat=24 Download aMule] 
Unpack it 
Patch aMule (for versions 2.1.3 and older)
* 'mv' the patch file into the extracted aMule directory
* type: patch -p1 < name_of_the_patch_file 
As user type:
*''./configure --disable-monolithic --with-toolkit=base --enable-amule-daemon --enable-amulecmd --enable-webserver''
*''make''
as root
*''make install''

That's it. You now have a working [[aMuled|aMule-daemon]] in ''/usr/local/bin'' 
Now you need to configure it. To create the ''~/.aMule/amule.conf'' file, which is the preferences file, run [[aMuled]] once. 
The ''~/.aMule'' directory and the ''~/.aMule/amule.conf'' file will be created in the home directory of the user that ran [[aMuled]]. 
::'''NOTE:''' In [[aMule]] versions previous to 2.0.0 the ''~/.aMule/amule.conf'' file was ''~/.eMule''. 
You probably want [[AMuleWeb|aMuleWeb]] to control your [[aMuled|daemon]]. To be able to use that you need to enable [[External Connections]]. Check [[AMuleWeb#aMuleWeb_with_aMule_2.0.0_or_later|this article]]. 
Also read the [[FAQ_amuled|aMuled FAQ]], since some setup things are mentioned there.

== Where to report problems and questions? ==

For problems or questions, post a message on [http://forum.amule.org aMule forum] or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

[[User:Stefanero|Stefanero]]
Updated by [[User:Vollstrecker|Vollstrecker]]

HowTo Compile aMuled

2007-12-14T06:21:41Z

Felipe1982: /* 1st */

<center> '''English''' | [[HowTo_Compile_aMuled-es|Español]] | [[HowTo_Compile_aMuled-nl|Nederlands]] | [[HowTo Compile aMuled-fr|Français]] | [[HowTo Compile aMuled-de|Deutsch]]</center>

== 1st ==

'''NOTE 1:''' In order to compile aMule 2.2.0 or higher you need wx 2.8.x.

'''NOTE 2:''' In order to compile aMule 2.1.3 with wx-2.8.x you need a Patch available [http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/aMule-wx.patch?rev=1.2 here]

'''NOTE 3:''' I had success with [http://www.wxwidgets.org/downloads/ wxall] (a.k.a. wxWidgets) instead of using wxBase --[[User:Felipe1982|Felipe1982]] 06:21, 14 December 2007 (UTC)

Download [[wxBase]] 2.8.1 or higher from http://www.wxWidgets.org
unpack it, and do as user
*''./configure --disable-gui --enable-unicode --without-subdirs --without-expat
*''make''
as root
*''make install''
*''ldconfig''

== 2nd ==

*Download [[aMule]] 2.1.3 (with patch) or higher (no patch needed) from http://www.amule.org/files/files.php?cat=24
*Patch aMule
** 'mv' the patch file into the extracted aMule directory
** type: patch -p1 < name_of_the_patch_file

Unpack it, and do as user
*''./configure --with-toolkit=base --enable-amulecmd --enable-webserver --disable-monolithic --enable-amule-daemon''
*''make''
as root
*''make install''

That's it. You now have a working [[aMuled|aMule-daemon]] in ''/usr/local/bin'' 
Now you need to configure it. To create the ''~/.aMule/amule.conf'' file, which is the preferences file, run [[aMuled]] once. 
The ''~/.aMule'' directory and the ''~/.aMule/amule.conf'' file will be created in the home directory of the user that ran [[aMuled]]. 
::'''NOTE:''' In [[aMule]] versions previous to 2.0.0 the ''~/.aMule/amule.conf'' file was ''~/.eMule''. 
You probably want [[AMuleWeb|aMuleWeb]] to control your [[aMuled|daemon]]. To be able to use that you need to enable [[External Connections]]. Check [[AMuleWeb#aMuleWeb_with_aMule_2.0.0_or_later|this article]]. 
Also read the [[FAQ_amuled|aMuled FAQ]], since some setup things are mentioned there.

== Where to report problems and questions? ==

For problems or questions, post a message on [http://forum.amule.org aMule forum] or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

[[User:Stefanero|Stefanero]]
Updated by [[User:Vollstrecker|Vollstrecker]]

HowTo Compile aMuled

2007-12-14T04:43:05Z

Felipe1982: /* 1st */

<center> '''English''' | [[HowTo_Compile_aMuled-es|Español]] | [[HowTo_Compile_aMuled-nl|Nederlands]] | [[HowTo Compile aMuled-fr|Français]] | [[HowTo Compile aMuled-de|Deutsch]]</center>

== 1st ==

'''NOTE:''' In order to compile aMule 2.2.0 or higher you need wx 2.8.x.

'''NOTE:''' In order to compile aMule 2.1.3 with wx-2.8.x you need a Patch available [http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/aMule-wx.patch?rev=1.2 here]

Download [[wxBase]] 2.8.1 or higher from [http://www.wxWidgets.org here]
unpack it, and do as user
*''./configure --disable-gui --enable-unicode --without-subdirs --without-expat
*''make''
as root
*''make install''
*''ldconfig''

== 2nd ==

*Download [[aMule]] 2.1.3 (with patch) or higher (no patch needed) from http://www.amule.org/files/files.php?cat=24
*Patch aMule
** 'mv' the patch file into the extracted aMule directory
** type: patch -p1 < name_of_the_patch_file

Unpack it, and do as user
*''./configure --with-toolkit=base --enable-amulecmd --enable-webserver --disable-monolithic --enable-amule-daemon''
*''make''
as root
*''make install''

That's it. You now have a working [[aMuled|aMule-daemon]] in ''/usr/local/bin'' 
Now you need to configure it. To create the ''~/.aMule/amule.conf'' file, which is the preferences file, run [[aMuled]] once. 
The ''~/.aMule'' directory and the ''~/.aMule/amule.conf'' file will be created in the home directory of the user that ran [[aMuled]]. 
::'''NOTE:''' In [[aMule]] versions previous to 2.0.0 the ''~/.aMule/amule.conf'' file was ''~/.eMule''. 
You probably want [[AMuleWeb|aMuleWeb]] to control your [[aMuled|daemon]]. To be able to use that you need to enable [[External Connections]]. Check [[AMuleWeb#aMuleWeb_with_aMule_2.0.0_or_later|this article]]. 
Also read the [[FAQ_amuled|aMuled FAQ]], since some setup things are mentioned there.

== Where to report problems and questions? ==

For problems or questions, post a message on [http://forum.amule.org aMule forum] or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

[[User:Stefanero|Stefanero]]
Updated by [[User:Vollstrecker|Vollstrecker]]

HowTo Compile aMuled

2007-12-03T07:12:11Z

Felipe1982: /* 2nd */

<center> '''English''' | [[HowTo_Compile_aMuled-es|Español]] | [[HowTo_Compile_aMuled-nl|Nederlands]] | [[HowTo Compile aMuled-fr|Français]] | [[HowTo Compile aMuled-de|Deutsch]]</center>

== 1st ==

'''NOTE:''' In order to compile aMule 2.2.0 or higher you need wx 2.8.x.

'''NOTE:''' In order to compile aMule 2.1.3 with wx-2.8.x you need a Patch available [http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/aMule-wx.patch?rev=1.2 here]

Download [[wxBase]] 2.8.1 or higher from [http://www.wxWidgets.org here]
unpack it, and do as user
*''./configure --prefix=/usr/ --enable-unicode''
*''make''
as root
*''make install''
*''ldconfig''

== 2nd ==

*Download [[aMule]] 2.1.3 (with patch) or higher (no patch needed) from http://www.amule.org/files/files.php?cat=24
*Patch aMule
** 'mv' the patch file into the extracted aMule directory
** type: patch -p1 < name_of_the_patch_file

Unpack it, and do as user
*''./configure --enable-amulecmd --enable-webserver --disable-monolithic --enable-amule-daemon''
*''make''
as root
*''make install''

That's it. You now have a working [[aMuled|aMule-daemon]] in ''/usr/local/bin'' 
Now you need to configure it. To create the ''~/.aMule/amule.conf'' file, which is the preferences file, run [[aMuled]] once. 
The ''~/.aMule'' directory and the ''~/.aMule/amule.conf'' file will be created in the home directory of the user that ran [[aMuled]]. 
::'''NOTE:''' In [[aMule]] versions previous to 2.0.0 the ''~/.aMule/amule.conf'' file was ''~/.eMule''. 
You probably want [[AMuleWeb|aMuleWeb]] to control your [[aMuled|daemon]]. To be able to use that you need to enable [[External Connections]]. Check [[AMuleWeb#aMuleWeb_with_aMule_2.0.0_or_later|this article]]. 
Also read the [[FAQ_amuled|aMuled FAQ]], since some setup things are mentioned there.

== Where to report problems and questions? ==

For problems or questions, post a message on [http://forum.amule.org aMule forum] or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

[[User:Stefanero|Stefanero]]
Updated by [[User:Vollstrecker|Vollstrecker]]

HowTo Compile aMuled

2007-12-03T07:05:58Z

Felipe1982:

<center> '''English''' | [[HowTo_Compile_aMuled-es|Español]] | [[HowTo_Compile_aMuled-nl|Nederlands]] | [[HowTo Compile aMuled-fr|Français]] | [[HowTo Compile aMuled-de|Deutsch]]</center>

== 1st ==

'''NOTE:''' In order to compile aMule 2.2.0 or higher you need wx 2.8.x.

'''NOTE:''' In order to compile aMule 2.1.3 with wx-2.8.x you need a Patch available [http://cvs.pld-linux.org/cgi-bin/cvsweb/SOURCES/aMule-wx.patch?rev=1.2 here]

Download [[wxBase]] 2.8.1 or higher from [http://www.wxWidgets.org here]
unpack it, and do as user
*''./configure --prefix=/usr/ --enable-unicode''
*''make''
as root
*''make install''
*''ldconfig''

== 2nd ==

*Download [[aMule]] 2.1.3 (with patch) or higher (no patch needed) from http://www.amule.org/files/files.php?cat=24
*Patch aMule '''(how does one do this?)'''

Unpack it, and do as user
*''./configure --enable-amulecmd --enable-webserver --disable-monolithic --enable-amule-daemon''
*''make''
as root
*''make install''

That's it. You now have a working [[aMuled|aMule-daemon]] in ''/usr/local/bin'' 
Now you need to configure it. To create the ''~/.aMule/amule.conf'' file, which is the preferences file, run [[aMuled]] once. 
The ''~/.aMule'' directory and the ''~/.aMule/amule.conf'' file will be created in the home directory of the user that ran [[aMuled]]. 
::'''NOTE:''' In [[aMule]] versions previous to 2.0.0 the ''~/.aMule/amule.conf'' file was ''~/.eMule''. 
You probably want [[AMuleWeb|aMuleWeb]] to control your [[aMuled|daemon]]. To be able to use that you need to enable [[External Connections]]. Check [[AMuleWeb#aMuleWeb_with_aMule_2.0.0_or_later|this article]]. 
Also read the [[FAQ_amuled|aMuled FAQ]], since some setup things are mentioned there.

== Where to report problems and questions? ==

For problems or questions, post a message on [http://forum.amule.org aMule forum] or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

[[User:Stefanero|Stefanero]]
Updated by [[User:Vollstrecker|Vollstrecker]]