AMule Project FAQ - User contributions [en]

User:Colin

2008-03-07T23:43:15Z

Colin: + hirnriss.net

Libupnp

2007-01-13T15:22:13Z

Colin: #redirect Universal_Plug_and_Play

#redirect [[Universal_Plug_and_Play]]

Universal Plug and Play

2007-01-13T15:21:17Z

Colin: terse --> explain

'''Universal Plug and Play (uPnP)''' is a new feature of [[aMule]] (CVS) which allows you to automatically configure the ports on your router, provided your router supports uPnP. This functionality is still being tested and should appear soon in an official release.

To use uPnP, you will need to install an external library, '''libupnp'''. It is highly recommended that you use libupnp version 1.4.1. You can download the source tarball from the project page at sourceforge [http://pupnp.sourceforge.net/] or install one of the packages available for various distros.

'''OpenSuse 10.2''' by [http://forum.amule.org/profile.php?userid=5567 Gerd78]
* [http://gw78.ja-nee.de/suse/10.2/i586/libupnp-1.4.1-0.i586.rpm libupnp-1.4.1-0.i586.rpm]
* [http://gw78.ja-nee.de/suse/10.2/i586/libupnp-devel-1.4.1-0.i586.rpm libupnp-devel-1.4.1-0.i586.rpm]

'''Ubuntu 6.10''' by [http://forum.amule.org/profile.php?userid=3842 Wuischke]
* [http://wuischke.hateworx.org/download/libupnp/libupnp_1.4.1-1_i386.deb libupnp_1.4.1-1_i386.deb]

'''Fedora Core 4, 5 and 6'''
* libupnp is included in Fedora Extras.

== External link ==
* [http://en.wikipedia.org/wiki/Universal_Plug_and_Play "Universal Plug and Play"]

MD4 hash

2006-12-28T20:28:54Z

Colin: reword

An '''MD4 hash''' is a unique value produced by a mathematical calculation. It provides a 128-bit (16 [[byte]]s, 32 hex chars) key from the data input which is claimed to be unique. As such, MD4 hashes are used to ensure data integrity.

[[aMule]] uses MD4 hashes to ensure that no transmission errors corrupt in the files you share. Its MD4 algorithm is based on [[libcrypto|Crypto++]].

MD4 was developed by MIT professor Ronald L. Rivest. It was accepted by the RSA in October 1990.

Both MD4, and its successor MD5, are optimized for 32-bit machines. Its predecessor MD2 was optimized for 8-bit machines. MD4 is known to be fast, but possibly not absolutely secure. On the other hand, MD5 is not as fast as MD4 but offers much more assurance of data security.

==External links==
* [http://www.faqs.org/rfcs/rfc1186.html RFC 1186: MD4]
* [http://www.faqs.org/rfcs/rfc1319.html RFC 1319: MD2]
* [http://www.faqs.org/rfcs/rfc1320.html RFC 1320: MD4]
* [http://theory.lcs.mit.edu/~rivest Home page of Ronald L. Rivest]
* [http://www.rsa.com RSA]

Events

2006-12-26T11:43:07Z

Colin: oops, bug somewhere

Events

2006-12-26T11:39:04Z

Colin: =Download completed= + /

<center>
'''English''' | [[events-de|German]] | [[events-nds|Low-Saxon]]
</center>

'''Events''' are actions aMule can take upon when certain things happen. These actions are configured on the [[Usage_Preferences#Events|Events]] tab of the [[Usage_Preferences]] notebook or, if you are running amuled, in the [UserEvents] section of [[amule.conf]].

There are two kinds of Events supported at the moment:
* Download completed
* New chat session
* Out of space
* Error on completion

When one of these events is triggered, you can configure aMule to execute a
* core command
* GUI command

A core command is a command that will be executed by a flavor of aMule that has a core (aMule daemon or aMule monolithic). A GUI command is a command that will be executed by a flavor of aMule that has GUI (aMule GUI or aMule monolithic). Notice that if you specify both, aMule monolithic will execute both.

=== Download completed ===

When aMule completes a download, a Download completed event is triggered. The following variables can be accessed:
* %NAME - the name of the downloaded file with full path
* %FILE - the name of the downloaded file without path
* %HASH - the ed2k hash of the downloaded file
* %SIZE - the size in bytes of the downloaded file
* %DLACTIVETIME - the total time the download was active

=== New chat session ===

When someone initiates a chat session with you, the New chat session event is triggered. When this happens, the following variable can be accessed:
* %Sender - username of the person initiating the chat

=== Out of space ===

When aMule runs out of diskspace on the partition which it uses for its temporary files, the Out of space event is triggered. When this happens, the following variable can be accessed:
* %PARTITION

=== Error on completion ===

When aMule is unable to move a file from the "temporary" directory to the "incoming" directory, an Error on completion event is triggered. This is typically caused by lack of diskspace on the partition where the incoming directory is located. When this happens, the following variable can be accessed:
* %FILE

=== Syntax ===

Event commands can be either a single or compound shell command, or a shell script. In the Core command field, enter the command or script name followed by the optional parameters like this:

:MyScript.sh %NAME %FILE %HASH %SIZE "%DLACTIVETIME"

'''Note:''' If the filename contains spaces, the variable names should be enclosed in quotes like this:

:MyScript.sh "%NAME" "%FILE" %HASH %SIZE "%DLACTIVETIME"

Your shell script can obtain the values in the parameters the customary way, ie, by evaluating $1, $2, $3, etc.

You need to make sure your script is in your PATH or that you supply the full pathname.

=== Errors ===

If your script fails to execute for any reason, this will be logged in aMule's [[logfile]]

<center>
'''English''' | [[events-de|German]] | [[events-nds|Low-Saxon]]
</center>

'''Events''' are actions aMule can take upon when certain things happen. These actions are configured on the [[Usage_Preferences#Events|Events]] tab of the [[Usage_Preferences]] notebook or, if you are running amuled, in the [UserEvents] section of [[amule.conf]].

There are two kinds of Events supported at the moment:
* Download completed
* New chat session
* Out of space
* Error on completion

When one of these events is triggered, you can configure aMule to execute a
* core command
* GUI command

A core command is a command that will be executed by a flavor of aMule that has a core (aMule daemon or aMule monolithic). A GUI command is a command that will be executed by a flavor of aMule that has GUI (aMule GUI or aMule monolithic). Notice that if you specify both, aMule monolithic will execute both.

=== Download completed ===

When aMule completes a download, a Download completed event is triggered. The following variables can be accessed:
* %NAME - the name of the downloaded file with full path
* %FILE - the name of the downloaded file without path
* %HASH - the ed2k hash of the downloaded file
* %SIZE - the size in bytes of the downloaded file
* %DLACTIVETIME - the total time the download was active

=== New chat session ===

When someone initiates a chat session with you, the New chat session event is triggered. When this happens, the following variable can be accessed:
* %Sender - username of the person initiating the chat

=== Out of space ===

When aMule runs out of diskspace on the partition which it uses for its temporary files, the Out of space event is triggered. When this happens, the following variable can be accessed:
* %PARTITION

=== Error on completion ===

When aMule is unable to move a file from the "temporary" directory to the "incoming" directory, an Error on completion event is triggered. This is typically caused by lack of diskspace on the partition where the incoming directory is located. When this happens, the following variable can be accessed:
* %FILE

=== Syntax ===

Event commands can be either a single or compound shell command, or a shell script. In the Core command field, enter the command or script name followed by the optional parameters like this:

:MyScript.sh %NAME %FILE %HASH %SIZE "%DLACTIVETIME"

'''Note:''' If the filename contains spaces, the variable names should be enclosed in quotes like this:

:MyScript.sh "%NAME" "%FILE" %HASH %SIZE "%DLACTIVETIME"

Your shell script can obtain the values in the parameters the customary way, ie, by evaluating $1, $2, $3, etc.

You need to make sure your script is in your PATH or that you supply the full pathname.

=== Errors ===

If your script fails to execute for any reason, this will be logged in aMule's [[logfile]]

== Examples ==

A simple command might look like this:

<pre>
echo "aMule error: %PARTITION is full." | mail -s Warning mymail@domain.tld
</pre>

This inserts the variable %PARTITION in the text of a one-line email message and sends it to the email address specfied.

For more elaborate purposes, you will will want to call an external script.

Here the bash script by '''Ezeltje''' from [http://forum.amule.org/thread.php?threadid=11695 aMule-Forum] which will send you an email every time a download is completed. To use it, enter your email address where indicated and save it to a location in your PATH. Then add this line:

<pre>
doneDL.sh "%NAME" "%FILE" %HASH %SIZE "%DLACTIVETIME"
</pre>

to the Core command field of the Download completed section of the Events page. It will now be invoked everytime aMule finishes a download.

#!/bin/bash
#
# doneDL.sh - sends an email upon completion of an aMule download
# Used in conjuction with aMule's Event feature
#
# Call like this: doneDL.sh "%NAME" "%FILE" %HASH %SIZE "%DLACTIVETIME"
#
# Enter your email address here:
eMail=
#
NameShort=$1
NameLong=$2
Hash=$3
Size=$4
DLtime=$5
{
echo aMule completed this download:
echo ------------------------------
echo
echo File: "$NameLong"
echo Hash: $Hash
echo -n "Time: "
date | awk '{print $4 " " $5}'
echo -n Size: $Size bytes
if [ $Size -gt 102400 ] ; then echo " ("$(($(($Size / 1024)) / 1024)) "Mb)" ; fi
if [ ! -z "$DLtime" ] ; then echo "Active download time:" $DLtime ; fi
echo
echo --------------------------------------------------------------------
cas
echo -n "Resident memory: "
echo $(ps u -C amule --no-headers | awk '{print $6}') kB
echo -n "Virtual memory: "
echo $(ps u -C amule --no-headers | awk '{print $5}') kB
echo --------------------------------------------------------------------
} | mail -s "$NameShort" $eMail

__NOTOC__

Hash

2006-12-22T20:23:42Z

Colin:

<center>'''English''' | [[Hash-hu|Magyar]] | [[Hash-es|Spanish]]
</center>

'''Hashes''' are mathematical algorithms which generate a unique code for a piece of data. They are used to uniquely identify files or groups of data.

In the [[FAQ_ed2k|ed2k network]], the most commonly used type of hash is the [[MD4 hash]], although [http://www.faqs.org/rfcs/rfc3174.html SHA-1] hashes are also used.

User:Colin

2006-12-22T03:24:36Z

Colin: =amuleCVSfx=

User:Colin

2006-12-22T03:23:17Z

Colin: =amuleCVSfx=

Rpm

2006-12-21T22:06:11Z

Colin: #REDIRECT RPM

#REDIRECT [[RPM]]

Usage aLinkCreatorConsole

2006-12-21T22:04:33Z

Colin: #REDIRECT ALinkCreatorConsole

#REDIRECT [[ALinkCreatorConsole]]

ALinkCreatorConsole

2006-12-21T22:03:54Z

Colin: reorg and merge contents of Usage_aLinkCreatorConsole

<center>
'''English''' | [[aLinkCreatorConsole-de|Deutsch]] |[[aLinkCreatorConsole-es|Spanish]]
</center>

'''ALinkCreatorConsole (alcc)''' is a command-line tool for creating [[Ed2k link]]s for files. It is a text-only equivalent of [[ALinkCreator]] (alc). alcc, like alc, calculates the ed2k hashes of files and displays the output formatted as a link that you can, for example, save in a file, paste in a web page, or send to a friend.

alcc is also able to create part-hashes, i.e. hashes for incomplete files.

alcc can be used without having the full aMule package installed.

== Installing alcc ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, alcc will be included in the installation.

This is the easiest and preferred method of installing alcc.

== Compiling alcc ==

If you have not installed aMule by means of a package, you will need to compile it from source.

alcc is not compiled separately; it is compiled at the same time you compile aMule by using the --enable-alcc flag when you run configure. (See the [[Main Page]] for links to pages on compiling aMule for various operating systems).

== Using alcc ==

To run alcc, type "alcc" on the command line in a terminal followed by a file name:

:$ alcc <filename>

Multiple filenames can be supplied, separated by spaces:

:$ alcc <filename1> <filename1> <filename3>.

You can copy its output from screen for use elsewhere.

:'''Note:''' If you intend to build an [[rpm]] by using the [[Spec_file|specfile]], aMule is shipped with, you need to add the entry ''%{_bindir}/alcc'' in the file-section. Otherise, an error message will displayed, "/usr/bin/alcc installed but not packaged",and rpmbuild will abort.

Spec file

2006-12-21T01:01:35Z

Colin: style, grammar

<center>
'''English''' | [[Spec_file-de|Deutsch]] | [[Spec_file-es|Spanish]]
</center>

A '''spec file''' is included in the [[aMule CVS]] tarball with which you can easily generate an [[RPM]] package.

It works like this:

# Download the latest aMule CVS tarball. It must be tarball of the ''same day'', these RPMs can only be built on the same day you download them.
#Run: ''rpmbuild -ta aMule-CVS-tarball.tar.bz2''
#When it is completed, you will have an RPM file which you can install with rpm.

:'''Not:''' You must have everything required to compile aMule previously installed in your system.

RPM

2006-12-20T13:57:42Z

Colin: new e

'''RPM''' is an abbreviation for '''Redhat Package Manager''', a package management system used by many Linux distros.

Installing an [[aMule]] RPM is easier than compiling from source. Many if not most distros have aMule RPMs available in their repositories.

==External link==

* [http://rpm.org rpm.org]

Tar

2006-12-20T13:53:06Z

Colin: new entry

'''tar''' is a command-line program for creating and unpacking file archives. It is widely used in the Unix environment.

tar archives are identified by the ".tar" suffix. If they have been compressed, the suffix will be "tar.gz" or "tar.bz2".

To compile the [[AMule]] source code, you first need to unpack the .tar archive. To do this, type

:$ tar xvjf [amule-source-tarball]

If you want to unpack the archive in a location other than the current directory, use the -C [destination] flag.

For example:

:$ tar xvjf aMule-CVS-20061202.tar.bz2 -C /usr/local/src

AMule SVN

2006-12-20T13:41:10Z

Colin: fxs

<center>'''English''' | [[AMule_CVS-es|Spanish]] | [[AMule_CVS-de|Deutsch]]</center>

'''AMule CVS''' is a [[tar]] archive of the latest developmental source code of [[aMule]]. It is automatically updated every night and can be downloaded from [http://amule.hirnriss.net hirnriss.net].

:'''Note:''' There are no guarantees that aMule CVS will compile and/or work properly. aMule CVS is a work-in-progress for users who want to keep up with the latest bleeding-edge developments. ''Use at your own risk!''

To run aMule CVS, you need to supply a mandatory command-line parameter which is changed regularly. To disable this, run this script: [[User:Colin#amuleCVSfx | amuleCVSfx]].

== RPM ==
To create an [[RPM]] package from an aMule CVS source tarball, use the included "spec file" See [[spec file]] for more information.

== Distro-specific sources ==

'''Gentoo''' users can grab the amule-cvs ebuild by consulting [[HowTo Compile In Gentoo]].

'''ArchLinux''' users can grab an unofficial amule-cvs PKGBUILD and binary by following [http://gift.altervista.org/index_en.php?section=40 this link] (No official support)

'''Debian testing/sid''' users can add this unofficial repository to their source.repo file:
<pre>
deb http://www.vollstreckernet.de/debian/ testing amule
</pre>
(See [http://forum.amule.org/thread.php?threadid=5776] for more information)

'''Mac OS X''' users can find CVS builds by following the instructions in [http://forum.amule.org/thread.php?threadid=5051 in this thread] on the forum.

User:Colin

2006-12-20T13:23:24Z

Colin: subh

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro
* expanded [[AMuleCMD]]

and other smaller fixes elsewhere...

---

== amuleCVSfx ==

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "_tmp.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the "amule-cvs" directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type
"yum install oorexx". For Ubuntu, type "apt-get install rexx-regina". Other distros probably have Rexx in their repositories under one name or another. Or you can download the source in various forms from sourceforge: [http://sourceforge.net/project/showfiles.php?group_id=119701]

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

AMule SVN

2006-12-20T01:26:35Z

Colin: style & grammar

<center>'''English''' | [[AMule_CVS-es|Spanish]] | [[AMule_CVS-de|Deutsch]]</center>

'''AMule CVS''' is the nightly [[aMule]] development tarball. It can be downloaded from [http://amule.hirnriss.net hirnriss.net].

By using amule-cvs, you understand that this version has no guarantees that it will compile and/or work properly. amule-cvs is a work-in-progress for users who want to keep up with the latest developments. ''Use at your own risk!''

* As of the 14th of March, 2005, a [[spec file]] is available in the [http://amule.hirnriss.net aMule CVS tarball] so that you may easily generate an [http://www.rpm.org RPM]. Read about it [[spec file| here]].

* [http://www.gentoo.org Gentoo] users can grab the amule-cvs ebuild by [[HowTo_Compile_In_Gentoo|following this link]].

* [http://www.archlinux.org ArchLinux] users can grab an unofficial amule-cvs PKGBUILD and binary by following [http://gift.altervista.org/index_en.php?section=40 this link] (No official support)

* [http://www.debian.org Debian] testing/sid unofficial repository (daily CVS packages. See [http://forum.amule.org/thread.php?threadid=5776 this] for more information):
:deb http://www.vollstreckernet.de/debian/ testing amule

* [http://www.apple.com/macosx/ Mac OS X] users can find CVS builds [http://forum.amule.org/thread.php?threadid=5051 in this thread] on the forum.

Universal plug and play

2006-12-20T01:21:41Z

Colin: #REDIRECT Universal Plug and Play

#REDIRECT [[Universal Plug and Play]]

External Connections

2006-12-20T01:20:33Z

Colin: reorg, grammar & spelling

''''External Connections''' (EC) is a bi-directional interface [[aMule]] uses to communicate with external utilities, specifically:

* [[aMuleWeb]]
* [[aMuleCMD]]
* [[aMuleGUI]]

When a user is using one of these programs, it is sending the commands via the External Connections port and [[aMule]] is reading them there.

Unless [[aMule]] and the external utilities are used on the same machine, you may need to configure your firewall and/or router to manage the ports properly, ie, open them to incoming traffic.

The [[Firewall]] article has instructions on how to do this.

As of December 2006, aMule CVS has experimental code enabling [[Universal plug and play]] (uPnP), which enables you to configure the ports on a uPnP-compatible router automatically. This functionality should soon be available in a general release.

'''NOTE for [[aMule_CVS|CVS]] users:''' It is very important that the aMuleWeb, aMuleCMD, and aMuleGUI you use are built from the same daily CVS tarball as aMule; mixing versions you are liable to experience crashes. For official releases, the developers take extra care that the worst that happens when you mix versions is a message "Invalid protocol version."

'''NOTE:''' There are alternate ways of communicating with [[aMule]] although External Connections is the only ''bi-directional'' way. Other ways of communication with [[aMule]] would be the [[Signature|Online Signature]] (outgoing direction) and [[ED2KLinks file]] (ingoing direction).

For more information on the EC protocol, see [[ECv2|External Connections v2]].

AMuleCMD

2006-12-20T00:55:32Z

Colin: =Configuring aMuleCMD=

'''AMuleCMD''' is a command-line utility that allows you to control [[aMule]] or [[aMuled]] either locally or remotely. The character-oriented interface offers a subset of aMule functionality, including searching for files, initializing downloads, and viewing your download queue. It also displays status information and allows you to change certain options.

To run aMuleCMD, type "amulecmd" on the command line. The program will start up and display the "aMulecmd$" prompt. The following commands are available:

*Available
*Add
*Cancel
*Connect
*Disconnect
*Exit
*Get
*Help
*Pause
*Quit
*Reload
*Resume
*Set
*Show
*Shutdown
*Statistics
*Status

For full instructions on how to use each command type 'help <command>' from within AmuleCMD.

In addition to running these commands from within aMuleCMD, you can also run them on the shell command line with the "-c" flag, like this:

:$amulecmd -c [command]

This enables you to call aMuleCMD from other scripts or from cron. See
[[FAQ amulecmd]] for more details on how to do this.

== Installing aMuleCMD ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, aMuleCMD will be included in the installation.

This is the easiest and preferred method of installing aMule and aMuleCMD.

== Compiling aMuleCMD ==

If you have not installed aMule by means of a package, you will need to compile it from source.

aMuleCMD is not compiled separately; it is compiled at the same time you compile aMule by using the --enable-amulecmd flag when you run configure. (See the Main Page for links to pages on compiling aMule for various operating systems).

== Configuring aMuleCMD ==

To use aMuleCMD, you first need to set several opions in aMule's Preferences notebook. On the "Remote Controls" page, you will need to:

* Enable "Accept External Connections".
* Enter a password for External Connections.

You can also modifiy the default External Connections port (4712) here as well, but if you do so, you will need to restart aMule for the changes to take effect.

(If you are running aMuled and don't want to use aMule to configure aMuleCMD, you can also edit "[ExternalConnect]" section of [[amule.conf file |amule.conf]]; see the instructions on the [[AMuleWeb]] page.)

Next, you need to do is generate [[remote.conf]], the file where aMuleCMD stores its configuration information. (It can be found in the .aMule directory.) Among other things, this file contains the port number which aMule uses for External Connections as well as the password needed to access aMule.

To create a ''remote.conf'' file, enter at the command line:

:amulecmd --create-config-from=/home/username/.aMule/amule.conf

where "username" is your user name.

aMuleCMD will read the necessary configuration information from amule.conf and generate a ''remote.conf'' file.

To do this on a remote system, enter this:

:amulecmd -h hostname -p ECport -P ECpassword -w

By default, the port is 4712, as indicated above.

'''Tip''' You can also simply copy ''remote.conf'' from the host system to the the remote computer, changing the hostname line accordingly.

User:Colin

2006-12-19T19:12:14Z

Colin: + sf

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro
* expanded [[AMuleCMD]]

and other smaller fixes elsewhere...

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "_tmp.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the "amule-cvs" directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type
"yum install oorexx". For Ubuntu, type "apt-get install rexx-regina". Other distros probably have Rexx in their repositories under one name or another. Or you can download the source in various forms from sourceforge: [http://sourceforge.net/project/showfiles.php?group_id=119701]

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

User:Colin

2006-12-19T19:09:04Z

Colin: fxs

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro
* expanded [[AMuleCMD]]

and other smaller fixes elsewhere...

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "_tmp.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the "amule-cvs" directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type
"yum install oorexx". For Ubuntu, type "apt-get install rexx-regina". Other distros probably have Rexx in their repositories under one name or another.

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

Universal Plug and Play

2006-12-19T19:02:56Z

Colin: new entry

UPnP

2006-12-19T18:58:02Z

Colin: #REDIRECT Universal Plug and Play

#REDIRECT [[Universal Plug and Play]]

Firewall

2006-12-19T18:54:26Z

Colin: =Firewalls= fmt

<center>'''English''' | [[Firewall-es|Español]] | [[Firewall-de|Deutsche]] </center>

== Firewalls ==

By default, firewalls and routers block incoming ports. To achieve the best results with aMule, you need to configure your firewall or router to open certain ports which aMule uses.

:'''Note''' As of mid-December 2006, aMule (CVS) has [[Universal Plug and Play]] (uPnP) capabilities which you can use to automatically configure the ports on your router, provided your router supports uPnP. This functionality is still being tested and should appear soon in an official release.

=== SuSE ===

'''[http://www.suse.com SuSE Linux]''' users try [[Firewall_SuSE|this HowTo]].

=== RedHat / Fedora Core ===

'''[http://fedora.redhat.com RedHat / Fedora Core]''' users try [[Firewall_Fedora|this HowTo]].

=== IPTables Configuration ===

If you set [http://www.ietf.org/rfc/rfc793.txt TCP] port in [[aMule]] to XX and [http://www.faqs.org/rfcs/rfc768.html UDP] port to YY then you have to set your firewall like this:

''iptables -A INPUT -p tcp --dport '''XX''' -j ACCEPT'' 
''iptables -A INPUT -p udp --dport '''XX+3''' -j ACCEPT'' 
''iptables -A INPUT -p udp --dport '''YY''' -j ACCEPT'' 

If you are building your iptables-rules from scratch, you also need to allow ''ESTABLISHED'' and ''RELATED'' traffic to come through your firewall:

''iptables -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT''

And you must enable traffic to leave your machine aswell, by either allowing all outgoing traffic:

''iptables -P OUTPUT ACCEPT''

or specifying special rules.

'''NOTE:''' for [http://www.mandrake.com Mandrake] 10.0 Official and [http://www.iptables.org iptables] you may have to change the multi-port entry to ''iptables -A INPUT -p udp --dport '''XX:ZZ''' -j ACCEPT'' where ''XX'' is the same [http://www.ietf.org/rfc/rfc793.txt TCP] port number used in first line and ''ZZ'' is that number plus 3 (eg: ''4662:4665'')

If you want to setup [[aMule]] behind a NAT gateway, you should add these lines to your [http://www.netfilter.org iptables] configuration script, on the gateway :

''EXTIF'' is your external interface

''EMULEPORT='''4662''''' 
''EMULEUDP='''4672''''' 
''EMULEUDP2=`expr $EMULEPORT + 3`'' 
''EMULEHOST='''10.0.0.2''''' 
''iptables -t nat -A PREROUTING -i $EXTIF -p tcp --destination-port $EMULEPORT -j DNAT --to-destination $EMULEHOST:$EMULEPORT'' 
''iptables -t nat -A PREROUTING -i $EXTIF -p udp --destination-port $EMULEUDP -j DNAT --to-destination $EMULEHOST:$EMULEUDP'' 
''iptables -t nat -A PREROUTING -i $EXTIF -p udp --destination-port $EMULEUDP2 -j DNAT --to-destination $EMULEHOST:$EMULEUDP2''

You also should make sure that your FORWARD-string is set up correctly. Usually, you will have an entry like this:

''iptables -A FORWARD -i $EXTIF -o $INTIF -d $EMULEHOST -m state --state ESTABLISHED,RELATED -j ACCEPT''

where ''INTIF'' is your internal interface and ''EMULEHOST'' is the host running the [[FAQ_eD2k-Kademlia#What_is_ED2K?|eD2k]] [[server]] on your internal network.

This will prevent new connections. So, you should allow all forwarding for [[aMule]]-related ports:

''iptables -A FORWARD -i $EXTIF -o $INTIF -p tcp --dport $EMULEPORT -d $EMULEHOST -j ACCEPT'' 
''iptables -A FORWARD -i $EXTIF -o $INTIF -p udp --dport $EMULEUDP -d $EMULEHOST -j ACCEPT'' 
''iptables -A FORWARD -i $EXTIF -o $INTIF -p udp --dport $EMULEUDP2 -d $EMULEHOST -j ACCEPT'' 

Once everything is set, you can check [http://www.amule.org/testport.php here] if your ports are now open.

== Routers ==

Here is a list of routers and how to set them up to forward their ports to [[aMule]].

In the descriptions below, examples are using the default ports (that is, ''4662'' for the [[Standard client TCP port]], ''4672'' for the [[Extended client UDP port]] and ''4665'' for the [[Extended server requests UDP port]].

=== Linksys WRT54GSV4 ===

#Open your web browser, ''http://192.168.1.1'' and log into it
#Go under ''Gaming applications''
#Now forward the ports to your computer:
##[[Standard client TCP port]]
###Change both ''Ports start'' and ''End'' to ''4662''
###In the next field set ''TCP''
###In the field, the last 3 digits of your LAN [[IP]]
##[[Extended client UDP port]]
###Change both ''Ports start'' and ''End'' to ''4672''
###In the next field set ''UDP''
###In the field, the last 3 digits of your LAN [[IP]]
##[[Extended server requests UDP port]]
###Change both ''Ports start'' and ''End'' to ''4665''
###In the next field set ''UDP''
###In the field, the last 3 digits of your LAN [[IP]]
#Now check ''Enable''
#And click ''Save settings''
#Then restart aMule :)

''--by '''Diablo69'''''

=== [http://www.linksys.com Linksys] Router configuration ===

This portion of the wiki applies only to stock versions of the [http://www.linksys.com Linksys] firmware. If you are using a [http://www.linksys.com Linksys] router running a variant of the [[GPL]] code, please follow the guides directly above as you are most likely using iptables.

Log into your [http://www.linksys.com Linksys] router. After successfully logging in, click on the main menu link labeled '''Applications & Gaming''' after which you should see an additional submenu list for this section. Make sure you are under the correct submenu by clicking '''Port Range Forwarding'''.

At this point, you should see a table with 6 columns. The columns are: ''Application'', ''Start to'', ''End'', ''Protocol'', ''IP Address'', ''Enable''.

'''The Application column''' 
Friendly name for the service. Put anything you want here, [[aMule]] being suggested.

'''The Start to -> End column''' 
Start and end ports. '''Start to''' should be ''4662'' but, in the end, this should reflect whatever port you have defined in [[aMule]] ''Preferences'' -> ''Connection'' -> ''Client TCP Port''. '''End''' should be ''4672'' but, in the end, this should reflect whatever port you have defined in [[aMule]] ''Preferences'' -> ''Connection'' -> ''eMule extended UDP Port''.

I suggest using 2 separate entries for each port unless this is not possible.

'''The Protocol column''' 
Protocol to listen for. If you use one line to open your [[aMule]] ports, set this option to '''Both'''. If you use a separate entry line for each, select option '''TCP''' for [[FAQ_ed2k#What_does_each_port_do?|Client TCP Port]] and option '''UDP''' for [[eMule]] [[FAQ_ed2k#What_does_each_port_do?|extended UDP Port]].

'''The IP Address column''' 
Internal [[IP|IP address]] to forward requests to. This is typically the internal (private) [[IP|IP address]] of the computer that will use [[aMule]].

'''The Enable column''' 
Enable rule. You'll need to check this in order to enable your [[aMule]] rules.

After adding your rule, make sure you save your settings. You can verify whether your rules work by [http://www.amule.org/testport.php testing your ports].

=== [http://www.dlink.com DLink] Router configuration ===

Log in to your [http://www.dlink.com DLink] router. There are three steps to take to enable your [[aMule]] [[port]]s.

'''IP Address setup'''

In the Home tab, click the DHCP button. This page displays the current [[IP address]]es assigned by the router, both static and dynamic. Look for the name or MAC address of the computer you'll be running [[aMule]] on. If your computer is receiving dynamically assigned [[IP address]]es, you will have to change your settings every so often if your [[IP address]] changes. To avoid this, use the Static DHCP section, and perform the following steps:

*'''Name''': Type in the name of your computer here, could be anything
*'''IP''': The [[IP address]] you want the router to always assign to your computer
*'''MAC Address''': The MAC address of your computer. You should be already connected to the router, so you can find your computer in the ''DHCP Client'' drop-down menu, and click clone, to populate this number
*Click ''Apply''

Now your computer will always receive the same [[IP address]].

Now click on the ''Advanced'' tab, and there are two areas that need to be updated:

'''Virtual Server'''
*Click the ''Virtual Server'' button. This page forwards external requests to a specific internal [[IP address]] in your network
*Click ''Enabled''
*Enter a name in the ''Name'' entry box, eg ''aMule TCP''
*Enter your static [[IP address]] in the ''Private IP'' box
*Select [http://www.ietf.org/rfc/rfc793.txt TCP] in ''Protocol type''
*Private [[port]] is the [[port]] that the router will forward the requests to on your computer. This can be anything, a good value is the default [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]], ''4662''
*Public [[port]] is the [[port]] that the router will receive requests on. Again, a good value is the [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] of ''4662''
*Schedule is the times at which the port is open. Select ''Always'', or whatever times you wish
*Click ''Apply''

'''Applications'''
*Click the ''Applications'' button. This page allows you to enter a range of [[port]]s to open for application usage
*Click ''Enabled''
*Enter the [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] in the first ''Trigger Port'' box, a good value being ''4662''
*Select ''Trigger Type'' as [http://www.ietf.org/rfc/rfc793.txt TCP]
*In ''Public Port'', enter the range from your [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] to your [[aMule]] [http://www.faqs.org/rfcs/rfc768.html UDP] [[port]], usually ''4662''-''4672''
*Select ''UDP'' as the ''Public Type''
*Click ''Apply''

You should now be all set, assuming that your computer firewall is setup to allow access on the selected [[port]]s.

'''Alternate Configuration (ie instead of Applications) for D-Link '''
*Go back to virtual server and set 2 other virtual servers for the UDP ports
(It works only that way on my D-Link DI-804HV)

*Virtual server aMuleUDP4665 - select your IP address and UDP and 4665 (port)

*Virtual Server aMuleUDP4672 - select your ip address and UDP and 4672 (port)

(disable the above amule applications if you did try and it do not work).
Then you shoudl have all arrows green ( and 3 virtual servers running for amule, 1 for TCP and 2 for UDP).

=== Netgear router ===

First, go to your router control page, locate at [http://routerlogin.net/start.htm http://routerlogin.net/start.htm]. Then, on the left side of the screen, under the Advanced group of options, click "Port Forwarding/Port Triggering." Click the "Add Custom Service" button, name it aMule1 (or whatever), set it as a TCP-only forwarding, with the starting and ending port being 4662 and the server IP address being whatever local address you're using (probably 192.168.1.2, if you're the only one connected to the router, but check), and click Apply. Repeat the process with aMule2 and aMule 3, using UDP-only ports for both and starting and ending ports of 4665 and 4672, respectively. (That is, the same starting and ending port within aMule2 and aMule3, but aMule2=4665 and aMule3=4672.) Make sure that iptables is properly set up on the machine which will run aMule (as above), and you're done.

=== TRENDnet router TW100 ===

First connect to your router: usually open a browser and type directly the router IP address: such as 192.168.0.1 (or 192.168.1.1), then the login box should appear ( depending on your router config) - if so answer the message log message with ‘admin’ as username and nothing as password (or you password if
you did set one).

Then On the left side Menu, Select Internet and thenselect Advanced Setup (Advanced Internet). Then click/select, [Special Applications]:

Add or replace 2 lines in the Special Applications list:
(Try not to remove something which you are using and which is already enabled)
(just add the new application for amule at the end in position Nr. 5 or Nr.6 in the list for example):

Create the entries as follows:

amuleU4665 TCP-4665-4665 UDP-4665-4665

amuleU4672 TCP-4672-4672 UDP-4672-4672 )

(In my Application List the “amuleU4665” and “amule4672” are in Nr1 and Nr2 but it can be in any position in your list).

->Click on the small box [ ] on the left for both lines of your amuleUxxxx applications to enable the special applications to work!

Then click on [Save], then click on [Close]

Then click on [Save] again on the page – Advanced Internet .

The next and last step is to click on the “Virtual Servers” menu on the left side, then the “Virtual Server page will appear”:

Add a new virtual server named like: AmuleTCP

Select your computer* IP Address: in the DropDown Menu

Select: TCP

Write the 4662 Port and 4662 port (both fields the same port)

Then [Add as new server]

Then you are set to have High ID and Kad ON. Finished with the Low-ID, yellow arrows and Kad Firewalled. Now all you arrows should be green and you should have access to Kad and ed2K.

''Important Note:''
*Be careful in the case that your computer is using the DHCP protocol (ie to obtain IP address from the router).
The router might not give all the time the same IP address to your computer.
(normally it does so... but sometimes it can change).
You have two solutions if you see that you have a low- ID then: (2 solutions)

1) log back to the router go back to the virtual server, select the amuleTCP virtual server that you created and just reselect you computer in the “PC(server)” entry box. And select [Update this server] and log out. It should do the job.

Or an alternative solution :

2)You can Set-up your computer with a fixed IP address if you want. If this problem of low-ID happens too often because you DHCP router gives different IP address to your computer, then you can put your computer in static mode or DHCP reserved address. But you need to know your DNS server(s) before to do that – so check with your ISP which are your DNS servers. Then configure your computer to run with a fixed DHCP/ Static address / Manual Address (name depends what OS you are running). For that go to your network settings and put the P address you want, and the gateway (you router IP address) and the DNS from your ISP – All this to be done ion the Other / PC Database (Admin) page of the router.

'''In the case that your TRENDNet router crashes or stop forwarding any''' traffic from/to your aMule computer . (it happened to me), then :

- reduce the Connection limit (in Preferences->Connection) to 100 (or to 50)
- reduce the "Max new connections / 5 secs" (in Preferences->Core Tweaks) to 10 (or to 5)
Stop amule and restart aMule so that configuration will be validated.

Make some tests to find your best config. It should give more stability to your router and avoid your router to crash ( ie you would have to reset and/or turn it on and off). This might be true for other routers as well(?).

''(TRENDnet Firewall from RFV - --[[User:Robert364|Robert364]] 17:05, 5 Nov 2006 (CET))
''

=== OpenBSD ===

The firewall that comes with OpenBSD is called packetfilter (pf). To get aMule running, you must add the following rules to your pf.conf (/etc/pf.conf):

''# aMule TCP and UDP'' 
''rdr on EXTIF proto tcp from any to any port 4662 -> IPADDR'' 
''rdr on EXTIF proto udp from any to any port 4672 -> IPADDR'' 
''rdr on EXTIF proto udp from any to any port 4665 -> IPADDR''

EXTIF is the name of your network-device that is connected with the internet. 
IPADDR is the internal ip-address of the computer in your network that runns aMule.

Example (device is '''/dev/xl0''', ip of computer running aMule is '''192.168.1.10'''):

''# aMule TCP and UDP'' 
''rdr on '''xl0''' proto tcp from any to any port 4662 -> '''192.168.1.10''' '' 
''rdr on '''xl0''' proto udp from any to any port 4672 -> '''192.168.1.10''' '' 
''rdr on '''xl0''' proto udp from any to any port 4665 -> '''192.168.1.10''' ''

Of course, the computer running aMule must also have access to the internet so add the following rules too:

''nat on EXTIF from IPADDR to any -> (EXTIF)'' 

EXTIF is the name of your network-device that is connected with the internet. 
IPADDR is the internal ip-address of the computer in your network that runns aMule.

Example (like above):

''nat on '''xl0''' from '''192.168.1.10''' to any -> ('''xl0''')''

Up to now there is no way (I could think of), to give KAD a better connection than "firewalled".

Firewall

2006-12-19T18:53:34Z

Colin: + uPnP

<center>'''English''' | [[Firewall-es|Español]] | [[Firewall-de|Deutsche]] </center>

== Firewalls ==

By default, firewalls and routers block incoming ports. To achieve the best results with aMule, you need to configure your firewall or router to open certain ports which aMule uses.

:'''uPnP''' As of mid-December 2006, aMule (CVS) has [[Universal Plug and Play]] (uPnP) capabilities which you can use to automatically configure the ports on your router, provided your router supports uPnP. This functionality is still being tested and should appear soon in an official release.

=== SuSE ===

'''[http://www.suse.com SuSE Linux]''' users try [[Firewall_SuSE|this HowTo]].

=== RedHat / Fedora Core ===

'''[http://fedora.redhat.com RedHat / Fedora Core]''' users try [[Firewall_Fedora|this HowTo]].

=== IPTables Configuration ===

If you set [http://www.ietf.org/rfc/rfc793.txt TCP] port in [[aMule]] to XX and [http://www.faqs.org/rfcs/rfc768.html UDP] port to YY then you have to set your firewall like this:

''iptables -A INPUT -p tcp --dport '''XX''' -j ACCEPT'' 
''iptables -A INPUT -p udp --dport '''XX+3''' -j ACCEPT'' 
''iptables -A INPUT -p udp --dport '''YY''' -j ACCEPT'' 

If you are building your iptables-rules from scratch, you also need to allow ''ESTABLISHED'' and ''RELATED'' traffic to come through your firewall:

''iptables -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT''

And you must enable traffic to leave your machine aswell, by either allowing all outgoing traffic:

''iptables -P OUTPUT ACCEPT''

or specifying special rules.

'''NOTE:''' for [http://www.mandrake.com Mandrake] 10.0 Official and [http://www.iptables.org iptables] you may have to change the multi-port entry to ''iptables -A INPUT -p udp --dport '''XX:ZZ''' -j ACCEPT'' where ''XX'' is the same [http://www.ietf.org/rfc/rfc793.txt TCP] port number used in first line and ''ZZ'' is that number plus 3 (eg: ''4662:4665'')

If you want to setup [[aMule]] behind a NAT gateway, you should add these lines to your [http://www.netfilter.org iptables] configuration script, on the gateway :

''EXTIF'' is your external interface

''EMULEPORT='''4662''''' 
''EMULEUDP='''4672''''' 
''EMULEUDP2=`expr $EMULEPORT + 3`'' 
''EMULEHOST='''10.0.0.2''''' 
''iptables -t nat -A PREROUTING -i $EXTIF -p tcp --destination-port $EMULEPORT -j DNAT --to-destination $EMULEHOST:$EMULEPORT'' 
''iptables -t nat -A PREROUTING -i $EXTIF -p udp --destination-port $EMULEUDP -j DNAT --to-destination $EMULEHOST:$EMULEUDP'' 
''iptables -t nat -A PREROUTING -i $EXTIF -p udp --destination-port $EMULEUDP2 -j DNAT --to-destination $EMULEHOST:$EMULEUDP2''

You also should make sure that your FORWARD-string is set up correctly. Usually, you will have an entry like this:

''iptables -A FORWARD -i $EXTIF -o $INTIF -d $EMULEHOST -m state --state ESTABLISHED,RELATED -j ACCEPT''

where ''INTIF'' is your internal interface and ''EMULEHOST'' is the host running the [[FAQ_eD2k-Kademlia#What_is_ED2K?|eD2k]] [[server]] on your internal network.

This will prevent new connections. So, you should allow all forwarding for [[aMule]]-related ports:

''iptables -A FORWARD -i $EXTIF -o $INTIF -p tcp --dport $EMULEPORT -d $EMULEHOST -j ACCEPT'' 
''iptables -A FORWARD -i $EXTIF -o $INTIF -p udp --dport $EMULEUDP -d $EMULEHOST -j ACCEPT'' 
''iptables -A FORWARD -i $EXTIF -o $INTIF -p udp --dport $EMULEUDP2 -d $EMULEHOST -j ACCEPT'' 

Once everything is set, you can check [http://www.amule.org/testport.php here] if your ports are now open.

== Routers ==

Here is a list of routers and how to set them up to forward their ports to [[aMule]].

In the descriptions below, examples are using the default ports (that is, ''4662'' for the [[Standard client TCP port]], ''4672'' for the [[Extended client UDP port]] and ''4665'' for the [[Extended server requests UDP port]].

=== Linksys WRT54GSV4 ===

#Open your web browser, ''http://192.168.1.1'' and log into it
#Go under ''Gaming applications''
#Now forward the ports to your computer:
##[[Standard client TCP port]]
###Change both ''Ports start'' and ''End'' to ''4662''
###In the next field set ''TCP''
###In the field, the last 3 digits of your LAN [[IP]]
##[[Extended client UDP port]]
###Change both ''Ports start'' and ''End'' to ''4672''
###In the next field set ''UDP''
###In the field, the last 3 digits of your LAN [[IP]]
##[[Extended server requests UDP port]]
###Change both ''Ports start'' and ''End'' to ''4665''
###In the next field set ''UDP''
###In the field, the last 3 digits of your LAN [[IP]]
#Now check ''Enable''
#And click ''Save settings''
#Then restart aMule :)

''--by '''Diablo69'''''

=== [http://www.linksys.com Linksys] Router configuration ===

This portion of the wiki applies only to stock versions of the [http://www.linksys.com Linksys] firmware. If you are using a [http://www.linksys.com Linksys] router running a variant of the [[GPL]] code, please follow the guides directly above as you are most likely using iptables.

Log into your [http://www.linksys.com Linksys] router. After successfully logging in, click on the main menu link labeled '''Applications & Gaming''' after which you should see an additional submenu list for this section. Make sure you are under the correct submenu by clicking '''Port Range Forwarding'''.

At this point, you should see a table with 6 columns. The columns are: ''Application'', ''Start to'', ''End'', ''Protocol'', ''IP Address'', ''Enable''.

'''The Application column''' 
Friendly name for the service. Put anything you want here, [[aMule]] being suggested.

'''The Start to -> End column''' 
Start and end ports. '''Start to''' should be ''4662'' but, in the end, this should reflect whatever port you have defined in [[aMule]] ''Preferences'' -> ''Connection'' -> ''Client TCP Port''. '''End''' should be ''4672'' but, in the end, this should reflect whatever port you have defined in [[aMule]] ''Preferences'' -> ''Connection'' -> ''eMule extended UDP Port''.

I suggest using 2 separate entries for each port unless this is not possible.

'''The Protocol column''' 
Protocol to listen for. If you use one line to open your [[aMule]] ports, set this option to '''Both'''. If you use a separate entry line for each, select option '''TCP''' for [[FAQ_ed2k#What_does_each_port_do?|Client TCP Port]] and option '''UDP''' for [[eMule]] [[FAQ_ed2k#What_does_each_port_do?|extended UDP Port]].

'''The IP Address column''' 
Internal [[IP|IP address]] to forward requests to. This is typically the internal (private) [[IP|IP address]] of the computer that will use [[aMule]].

'''The Enable column''' 
Enable rule. You'll need to check this in order to enable your [[aMule]] rules.

After adding your rule, make sure you save your settings. You can verify whether your rules work by [http://www.amule.org/testport.php testing your ports].

=== [http://www.dlink.com DLink] Router configuration ===

Log in to your [http://www.dlink.com DLink] router. There are three steps to take to enable your [[aMule]] [[port]]s.

'''IP Address setup'''

In the Home tab, click the DHCP button. This page displays the current [[IP address]]es assigned by the router, both static and dynamic. Look for the name or MAC address of the computer you'll be running [[aMule]] on. If your computer is receiving dynamically assigned [[IP address]]es, you will have to change your settings every so often if your [[IP address]] changes. To avoid this, use the Static DHCP section, and perform the following steps:

*'''Name''': Type in the name of your computer here, could be anything
*'''IP''': The [[IP address]] you want the router to always assign to your computer
*'''MAC Address''': The MAC address of your computer. You should be already connected to the router, so you can find your computer in the ''DHCP Client'' drop-down menu, and click clone, to populate this number
*Click ''Apply''

Now your computer will always receive the same [[IP address]].

Now click on the ''Advanced'' tab, and there are two areas that need to be updated:

'''Virtual Server'''
*Click the ''Virtual Server'' button. This page forwards external requests to a specific internal [[IP address]] in your network
*Click ''Enabled''
*Enter a name in the ''Name'' entry box, eg ''aMule TCP''
*Enter your static [[IP address]] in the ''Private IP'' box
*Select [http://www.ietf.org/rfc/rfc793.txt TCP] in ''Protocol type''
*Private [[port]] is the [[port]] that the router will forward the requests to on your computer. This can be anything, a good value is the default [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]], ''4662''
*Public [[port]] is the [[port]] that the router will receive requests on. Again, a good value is the [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] of ''4662''
*Schedule is the times at which the port is open. Select ''Always'', or whatever times you wish
*Click ''Apply''

'''Applications'''
*Click the ''Applications'' button. This page allows you to enter a range of [[port]]s to open for application usage
*Click ''Enabled''
*Enter the [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] in the first ''Trigger Port'' box, a good value being ''4662''
*Select ''Trigger Type'' as [http://www.ietf.org/rfc/rfc793.txt TCP]
*In ''Public Port'', enter the range from your [[aMule]] [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] to your [[aMule]] [http://www.faqs.org/rfcs/rfc768.html UDP] [[port]], usually ''4662''-''4672''
*Select ''UDP'' as the ''Public Type''
*Click ''Apply''

You should now be all set, assuming that your computer firewall is setup to allow access on the selected [[port]]s.

'''Alternate Configuration (ie instead of Applications) for D-Link '''
*Go back to virtual server and set 2 other virtual servers for the UDP ports
(It works only that way on my D-Link DI-804HV)

*Virtual server aMuleUDP4665 - select your IP address and UDP and 4665 (port)

*Virtual Server aMuleUDP4672 - select your ip address and UDP and 4672 (port)

(disable the above amule applications if you did try and it do not work).
Then you shoudl have all arrows green ( and 3 virtual servers running for amule, 1 for TCP and 2 for UDP).

=== Netgear router ===

First, go to your router control page, locate at [http://routerlogin.net/start.htm http://routerlogin.net/start.htm]. Then, on the left side of the screen, under the Advanced group of options, click "Port Forwarding/Port Triggering." Click the "Add Custom Service" button, name it aMule1 (or whatever), set it as a TCP-only forwarding, with the starting and ending port being 4662 and the server IP address being whatever local address you're using (probably 192.168.1.2, if you're the only one connected to the router, but check), and click Apply. Repeat the process with aMule2 and aMule 3, using UDP-only ports for both and starting and ending ports of 4665 and 4672, respectively. (That is, the same starting and ending port within aMule2 and aMule3, but aMule2=4665 and aMule3=4672.) Make sure that iptables is properly set up on the machine which will run aMule (as above), and you're done.

=== TRENDnet router TW100 ===

First connect to your router: usually open a browser and type directly the router IP address: such as 192.168.0.1 (or 192.168.1.1), then the login box should appear ( depending on your router config) - if so answer the message log message with ‘admin’ as username and nothing as password (or you password if
you did set one).

Then On the left side Menu, Select Internet and thenselect Advanced Setup (Advanced Internet). Then click/select, [Special Applications]:

Add or replace 2 lines in the Special Applications list:
(Try not to remove something which you are using and which is already enabled)
(just add the new application for amule at the end in position Nr. 5 or Nr.6 in the list for example):

Create the entries as follows:

amuleU4665 TCP-4665-4665 UDP-4665-4665

amuleU4672 TCP-4672-4672 UDP-4672-4672 )

(In my Application List the “amuleU4665” and “amule4672” are in Nr1 and Nr2 but it can be in any position in your list).

->Click on the small box [ ] on the left for both lines of your amuleUxxxx applications to enable the special applications to work!

Then click on [Save], then click on [Close]

Then click on [Save] again on the page – Advanced Internet .

The next and last step is to click on the “Virtual Servers” menu on the left side, then the “Virtual Server page will appear”:

Add a new virtual server named like: AmuleTCP

Select your computer* IP Address: in the DropDown Menu

Select: TCP

Write the 4662 Port and 4662 port (both fields the same port)

Then [Add as new server]

Then you are set to have High ID and Kad ON. Finished with the Low-ID, yellow arrows and Kad Firewalled. Now all you arrows should be green and you should have access to Kad and ed2K.

''Important Note:''
*Be careful in the case that your computer is using the DHCP protocol (ie to obtain IP address from the router).
The router might not give all the time the same IP address to your computer.
(normally it does so... but sometimes it can change).
You have two solutions if you see that you have a low- ID then: (2 solutions)

1) log back to the router go back to the virtual server, select the amuleTCP virtual server that you created and just reselect you computer in the “PC(server)” entry box. And select [Update this server] and log out. It should do the job.

Or an alternative solution :

2)You can Set-up your computer with a fixed IP address if you want. If this problem of low-ID happens too often because you DHCP router gives different IP address to your computer, then you can put your computer in static mode or DHCP reserved address. But you need to know your DNS server(s) before to do that – so check with your ISP which are your DNS servers. Then configure your computer to run with a fixed DHCP/ Static address / Manual Address (name depends what OS you are running). For that go to your network settings and put the P address you want, and the gateway (you router IP address) and the DNS from your ISP – All this to be done ion the Other / PC Database (Admin) page of the router.

'''In the case that your TRENDNet router crashes or stop forwarding any''' traffic from/to your aMule computer . (it happened to me), then :

- reduce the Connection limit (in Preferences->Connection) to 100 (or to 50)
- reduce the "Max new connections / 5 secs" (in Preferences->Core Tweaks) to 10 (or to 5)
Stop amule and restart aMule so that configuration will be validated.

Make some tests to find your best config. It should give more stability to your router and avoid your router to crash ( ie you would have to reset and/or turn it on and off). This might be true for other routers as well(?).

''(TRENDnet Firewall from RFV - --[[User:Robert364|Robert364]] 17:05, 5 Nov 2006 (CET))
''

=== OpenBSD ===

The firewall that comes with OpenBSD is called packetfilter (pf). To get aMule running, you must add the following rules to your pf.conf (/etc/pf.conf):

''# aMule TCP and UDP'' 
''rdr on EXTIF proto tcp from any to any port 4662 -> IPADDR'' 
''rdr on EXTIF proto udp from any to any port 4672 -> IPADDR'' 
''rdr on EXTIF proto udp from any to any port 4665 -> IPADDR''

EXTIF is the name of your network-device that is connected with the internet. 
IPADDR is the internal ip-address of the computer in your network that runns aMule.

Example (device is '''/dev/xl0''', ip of computer running aMule is '''192.168.1.10'''):

''# aMule TCP and UDP'' 
''rdr on '''xl0''' proto tcp from any to any port 4662 -> '''192.168.1.10''' '' 
''rdr on '''xl0''' proto udp from any to any port 4672 -> '''192.168.1.10''' '' 
''rdr on '''xl0''' proto udp from any to any port 4665 -> '''192.168.1.10''' ''

Of course, the computer running aMule must also have access to the internet so add the following rules too:

''nat on EXTIF from IPADDR to any -> (EXTIF)'' 

EXTIF is the name of your network-device that is connected with the internet. 
IPADDR is the internal ip-address of the computer in your network that runns aMule.

Example (like above):

''nat on '''xl0''' from '''192.168.1.10''' to any -> ('''xl0''')''

Up to now there is no way (I could think of), to give KAD a better connection than "firewalled".

AMuleCMD

2006-12-19T18:45:12Z

Colin: =Configuring aMuleCMD= sp.

'''AMuleCMD''' is a command-line utility that allows you to control [[aMule]] or [[aMuled]] either locally or remotely. The character-oriented interface offers a subset of aMule functionality, including searching for files, initializing downloads, and viewing your download queue. It also displays status information and allows you to change certain options.

To run aMuleCMD, type "amulecmd" on the command line. The program will start up and display the "aMulecmd$" prompt. The following commands are available:

*Available
*Add
*Cancel
*Connect
*Disconnect
*Exit
*Get
*Help
*Pause
*Quit
*Reload
*Resume
*Set
*Show
*Shutdown
*Statistics
*Status

For full instructions on how to use each command type 'help <command>' from within AmuleCMD.

In addition to running these commands from within aMuleCMD, you can also run them on the shell command line with the "-c" flag, like this:

:$amulecmd -c [command]

This enables you to call aMuleCMD from other scripts or from cron. See
[[FAQ amulecmd]] for more details on how to do this.

== Installing aMuleCMD ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, aMuleCMD will be included in the installation.

This is the easiest and preferred method of installing aMule and aMuleCMD.

== Compiling aMuleCMD ==

If you have not installed aMule by means of a package, you will need to compile it from source.

aMuleCMD is not compiled separately; it is compiled at the same time you compile aMule by using the --enable-amulecmd flag when you run configure. (See the Main Page for links to pages on compiling aMule for various operating systems).

== Configuring aMuleCMD ==

To use aMuleCMD, you first need to set several opions in aMule's Preferences notebook. On the "Remote Controls" page, you will need to:

* Enable "Accept External Connections".
* Enter a password for External Connections.

You can also modifiy the default aMuleCMD port (4711) and External Connections port (4712) here as well, but if you do so, you will need to restart aMule for the changes to take effect.

(If you are running aMuled and don't want to use aMule to configure aMuleCMD, you can also edit "[ExternalConnect]" section of [[amule.conf file |amule.conf]]; see the instructions on the [[AMuleWeb]] page.)

Next, you need to do is generate [[remote.conf]], the file where aMuleCMD stores its configuration information. (It can be found in the .aMule directory.) Among other things, this file contains the port number which aMule uses for External Connections as well as the password needed to access aMule.

To create a ''remote.conf'' file, enter at the command line:

:amulecmd --create-config-from=/home/username/.aMule/amule.conf

where "username" is your user name.

aMuleCMD will read the necessary configuration information from amule.conf and generate a ''remote.conf'' file.

To do this on a remote system, enter this:

:amulecmd -h hostname -p ECport -P ECpassword -w

'''Tip''' You can also simply copy ''remote.conf'' from the host system to the the remote computer, changing the hostname line accordingly.

AMuleCMD

2006-12-19T18:43:52Z

Colin: reorg, expand

'''AMuleCMD''' is a command-line utility that allows you to control [[aMule]] or [[aMuled]] either locally or remotely. The character-oriented interface offers a subset of aMule functionality, including searching for files, initializing downloads, and viewing your download queue. It also displays status information and allows you to change certain options.

To run aMuleCMD, type "amulecmd" on the command line. The program will start up and display the "aMulecmd$" prompt. The following commands are available:

*Available
*Add
*Cancel
*Connect
*Disconnect
*Exit
*Get
*Help
*Pause
*Quit
*Reload
*Resume
*Set
*Show
*Shutdown
*Statistics
*Status

For full instructions on how to use each command type 'help <command>' from within AmuleCMD.

In addition to running these commands from within aMuleCMD, you can also run them on the shell command line with the "-c" flag, like this:

:$amulecmd -c [command]

This enables you to call aMuleCMD from other scripts or from cron. See
[[FAQ amulecmd]] for more details on how to do this.

== Installing aMuleCMD ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, aMuleCMD will be included in the installation.

This is the easiest and preferred method of installing aMule and aMuleCMD.

== Compiling aMuleCMD ==

If you have not installed aMule by means of a package, you will need to compile it from source.

aMuleCMD is not compiled separately; it is compiled at the same time you compile aMule by using the --enable-amulecmd flag when you run configure. (See the Main Page for links to pages on compiling aMule for various operating systems).

== Configuring aMuleCMD ==

To use aMuleCMD, you first need to set several opions in aMule's Preferences notebook. On the "Remote Controls" page, you will need to:

* Enable "Accept External Connections".
* Enter a password for External Connections.

You can also modifiy the default aMuleCMD port (4711) and External Connections port (4712) here as well, but if you do so, you will need to restart aMule for the changes to take effect.

(If you are running aMuled and don't want to use aMule to configure aMuleCMD, you can also edit "[ExternalConnect]" section of [[amule.conf file |amule.conf]]; see the instructions on the [[AMuleWeb]] page.)

Next, you need to do is generate [[remote.conf]], the file where aMuleCMD stores its configuration information. (It can be found in the .aMule directory.) Among other things, this file contains the port number which aMule uses for External Connections as well as the password needed to access aMule.

To create a ''remote.conf'' file, enter at the command line:

:amulecmd --create-config-from=/home/username/.aMule/amule.conf

were "username" is your user name.

aMuleCMD will read the necessary configuration information from amule.conf and generate a ''remote.conf'' file.

To do this on a remote system, enter this:

:amulecmd -h hostname -p ECport -P ECpassword -w

'''Tip''' You can also simply copy ''remote.conf'' from the host system to the the remote computer, changing the hostname line accordingly.

AMulecmd

2006-12-19T18:13:30Z

Colin: #REDIRECT AMuleCMD

#REDIRECT [[AMuleCMD]]

Events

2006-12-18T21:58:04Z

Colin: fmt

Events

2006-12-18T21:54:52Z

Colin: =Examples= fmt

Events

2006-12-18T21:53:40Z

Colin: fxs

Logfile file

2006-12-17T16:32:54Z

Colin: + logfile.bak

== File ==

'''Name:''' ''logfile''

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

== Description ==

This [[file]] contains the [[log]] of the last (or current if still active) [[aMule]] execution.

It contains all errors, warning and messages aMule has reported.

When aMule starts, it creates a new log. The previous log is stored as "logfile.bak".

== Format ==

It's format is very simple:

''<Date> <Time>: <Log-line>''

This are the field's meanings:
*'''Date''': Stands for the date when the log line was reported (in YYYY-MM-DD foramt)
*'''Time''': Stands for the time when the log line was reported (in HH:MM:SS format)
*'''Log-line''': Stands for the log line itself

== Example ==

This is the contents of a possible log file:

2005-12-11 06:57:57: Creditfile loaded, 21523 clients are known
2005-12-11 06:57:58:
2005-12-11 06:57:58: - This is aMule CVS using wxGTK2 v2.6.1 (Unicoded) (Snapshot: rev. 5953) based on eMule.
2005-12-11 06:57:58: Running on Linux 2.6.14.3 i686
2005-12-11 06:57:58: - Visit http://www.amule.org to check if a new version is available.
2005-12-11 06:57:58:
2005-12-11 06:57:58: Loading ipfilter.dat files.
2005-12-11 06:57:58: Loaded 571 IP-ranges from 'ipfilter.dat'. 1 malformed lines were discarded.
2005-12-11 06:57:59: Loaded 0 IP-ranges from 'ipfilter_static.dat'. 0 malformed lines were discarded.
2005-12-11 06:57:59: Loading server.met file: /home/jacobo/.aMule/server.met
2005-12-11 06:57:59: 73 servers in server.met found
2005-12-11 06:58:01: Found 168 part files
2005-12-11 06:58:01: *** TCP socket (ECServer) listening on 0.0.0.0:4712
2005-12-11 06:58:01: Found 87 known shared files
2005-12-11 06:58:06: AICH Thread: Syncronization thread started.
2005-12-11 06:58:06: AICH Thread: Masterhashes of known files have been loaded.
2005-12-11 06:58:06: AICH Thread: No new files found.
2005-12-11 06:58:06: AICH Thread: Terminated.
2005-12-11 06:58:06: Connecting
2005-12-11 06:58:07: Connecting to Rasorpack 2.0 (19.25.44.23 - 19.25.44.23:80)
2005-12-11 06:58:07: Read 0 Kad contacts
2005-12-11 06:58:08: Connecting to Rasorpack 3 (20.1.16.36 - 20.1.16.36:5000)
2005-12-11 06:58:08: Connected to Rasorpack 2.0 (19.25.44.23:4661)
2005-12-11 06:58:08: Connected to Kad (firewalled)
2005-12-11 06:58:09: Connection established on: Rasorpack 2.0
2005-12-11 06:58:09: Connected to Rasorpack 2.0 with HighID
2005-12-11 06:58:09: New clientid is 675249139
2005-12-11 06:58:09: ServerMessage: server version 17.7 (lugdunum)
2005-12-11 06:58:09: ServerMessage: Rasorpack 2 - Dual Opteron Server / www.rasorpack2.com
2005-12-11 06:58:09: ServerMessage: .
2005-12-11 06:58:09: ServerMessage: We cannot be held responsible for any illegal use that could be made of this server
2005-12-11 06:58:09: ServerMessage: .
2005-12-11 06:58:09: ServerMessage: Use an up-to-date client to get better results
2005-12-11 06:58:09: ServerMessage: Information about the last versions of eD2k clients :
2005-12-11 06:58:09: ServerMessage: http://www.rasorpack2.com/fr/faqs/msg/48
2005-12-11 06:58:09: ServerMessage: .
2005-12-11 06:58:09: ServerMessage: Urgente : Mejorad la seguridad de vuestra mula : http://www.rasorpack2.com/fr/faqs/msg/50
2005-12-11 06:58:09: ServerMessage: .
2005-12-11 06:58:09: ServerMessage: Descarga rapidissima y sin limite - Prueben gratis
2005-12-11 06:58:09: ServerMessage: .
2005-12-11 06:59:00: Downloading Make.aMule.mine.rar
2005-12-11 06:59:33: Deleting file: Old.free.film.avi
2005-12-11 07:01:53: Connected to Kad (ok)

== Notes ==

If a log line contains more than just one single line, it will only be given a date and time once, at the beginning of the first line.

Logfile

2006-12-17T16:31:58Z

Colin: redirect

#REDIRECT [[Logfile file]]

Amule.conf file

2006-12-17T16:27:35Z

Colin: =File=

<center>'''English''' | [[Amule.conf_file-de|German]]</center>

== File ==
'''Name:''' ''amule.conf''

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

== Description ==
This file contains [[aMule]]'s configuration.

<center>'''English''' | [[Amule.conf_file-de|German]]</center>

== File ==
'''Name:''' ''amule.conf''

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

== Description ==
This file contains [[aMule]]'s configuration.

== Format ==
amule.conf is a plain text file which you can open and modify using any standard editor.

'#' is a special character; any text after this character is identified as a comment and will be ignored.

== Example ==
Following an amule.conf file fresh after a new install:
<pre>
[eMule]
AppVersion=aMule 2.1.0
Nick=http://www.aMule.org
NewVersionCheck=0
StartupMinimized=0
ConfirmExit=0
EnableTrayIcon=0
MinToTray=0
ToolTipDelay=1
MaxDownload=0
MaxUpload=0
SlotAllocation=2
DownloadCapacity=3
UploadCapacity=3
Port=4662
UDPPort=4672
UDPDisable=0
MaxSourcesPerFile=300
MaxConnections=500
ConnectToED2K=1
ConnectToKad=1
Autoconnect=1
Reconnect=1
ShowOverhead=0
RemoveDeadServer=1
DeadServerRetry=2
Serverlist=0
AddServersFromServer=1
AddServersFromClient=1
Scoresystem=1
SmartIdCheck=1
SafeServerConnect=0
AutoConnectStaticOnly=0
ManualHighPrio=0
ICH=1
AICHTrust=0
AddNewFilesPaused=0
DAPPref=1
PreviewPrio=0
UAPPref=1
FullChunkTransfers=1
StartNextFile=0
StartNextFileSameCat=0
CheckDiskspace=1
MinFreeDiskSpace=1
ExecOnCompletion=0
ExecOnCompletionCommand=sh -c '~/example.sh "%FILE" %HASH'
IncomingDir=/home/ihmselbst/.aMule/Incoming
TempDir=/home/ihmselbst/.aMule/Temp
ShareHiddenFiles=0
VideoPlayer=
VideoPreviewBackupped=1
StatGraphsInterval=3
StatsAverageMinutes=5
VariousStatisticsMaxValue=100
statsInterval=30
MaxConnectionsPerFiveSeconds=20
FileBufferSizePref=16
QueueSizePref=50
ServerKeepAliveTimeout=0
3DDepth=10
AutoSortDownloads=0
ShowInfoOnCatTabs=0
ShowRatesOnTitle=0
VerticalToolbar=0
SeeShare=2
IPFilterAutoLoad=1
IPFilterURL=
FilterLevel=127
FilterLanIPs=1
OnlineSignature=0
OnlineSignatureUpdate=5
OSDirectory=/home/ihmselbst/.aMule/
FilterMessages=0
FilterAllMessages=0
MessagesFromFriendsOnly=0
MessageFromValidSourcesOnly=1
FilterWordMessages=0
MessageFilter=
VerboseDebug=0
Language=
SplitterbarPosition=75
YourHostname=
DateTimeFormat=%A, %x, %X
IndicateRatings=1
AllcatType=0
ShowAllNotCats=0
DisableKnownClientList=0
DisableQueueList=0
MaxMessageSessions=50
PermissionsFiles=416
PermissionsDirs=488
Address=
StatColor0=4194304
StatColor1=16761024
StatColor2=8454016
StatColor3=53760
StatColor4=32768
StatColor5=8421631
StatColor6=200
StatColor7=140
StatColor8=16750230
StatColor9=12583104
StatColor10=8454143
StatColor11=0
StatColor12=8454016
StatColor13=53760
StatColor14=32768
TableSortingServer=0
TableWidthsServer=150,140,25,150,25,40,45,60,40,40,80
TableSortingDownload=0
TableWidthsDownload=260,60,65,65,65,170,50,55,70,110,220,220
TableSortingUploads=0
TableWidthsUploads=150,275,100,60,65,60,60,110,100,100,100
TableSortingShared=0
TableWidthsShared=250,100,50,70,220,100,100,120,120,120,220
[FakeCheck]
Browser=0
CustomBrowser=
BrowserTab=1
[ExternalConnect]
UseSrcSeeds=0
ShowPercent=0
ShowProgressBar=1
AcceptExternalConnections=0
ECAddress=
ECPort=4712
ECPassword=
IpFilterOn=1
UseSecIdent=1
[Statistics]
MaxClientVersions=0
TotalDownloadedBytes=0
TotalUploadedBytes=0
[SkinGUIOptions]
UseSkinFile=0
SkinFile=
[Razor_Preferences]
FastED2KLinksHandler=1
NoNeededSourcesHandling=2
FullQueueSources=0
HighQueueRankingSources=0
HighQueueRanking=1200
AutoDropTimer=240
MAIN_X_POS=217
MAIN_Y_POS=100
MAIN_X_SIZE=800
MAIN_Y_SIZE=600
SRV_SPLITTER_POS=463
[WebServer]
Enabled=0
Port=4711
PageRefreshTime=120
UseGzip=1
UseLowRightsUser=0
Password=
PasswordLow=
Template=
[Proxy]
ProxyEnableProxy=0
ProxyType=0
ProxyName=
ProxyPort=1080
ProxyEnablePassword=0
ProxyUser=
ProxyPassword=
[GUI]
[GUI/TransferWnd]
Splitter=114
ShowClientList=1
</pre>

== Example ==
Following an amule.conf file fresh after a new install:
<pre>
[eMule]
AppVersion=aMule 2.1.0
Nick=http://www.aMule.org
NewVersionCheck=0
StartupMinimized=0
ConfirmExit=0
EnableTrayIcon=0
MinToTray=0
ToolTipDelay=1
MaxDownload=0
MaxUpload=0
SlotAllocation=2
DownloadCapacity=3
UploadCapacity=3
Port=4662
UDPPort=4672
UDPDisable=0
MaxSourcesPerFile=300
MaxConnections=500
ConnectToED2K=1
ConnectToKad=1
Autoconnect=1
Reconnect=1
ShowOverhead=0
RemoveDeadServer=1
DeadServerRetry=2
Serverlist=0
AddServersFromServer=1
AddServersFromClient=1
Scoresystem=1
SmartIdCheck=1
SafeServerConnect=0
AutoConnectStaticOnly=0
ManualHighPrio=0
ICH=1
AICHTrust=0
AddNewFilesPaused=0
DAPPref=1
PreviewPrio=0
UAPPref=1
FullChunkTransfers=1
StartNextFile=0
StartNextFileSameCat=0
CheckDiskspace=1
MinFreeDiskSpace=1
ExecOnCompletion=0
ExecOnCompletionCommand=sh -c '~/example.sh "%FILE" %HASH'
IncomingDir=/home/ihmselbst/.aMule/Incoming
TempDir=/home/ihmselbst/.aMule/Temp
ShareHiddenFiles=0
VideoPlayer=
VideoPreviewBackupped=1
StatGraphsInterval=3
StatsAverageMinutes=5
VariousStatisticsMaxValue=100
statsInterval=30
MaxConnectionsPerFiveSeconds=20
FileBufferSizePref=16
QueueSizePref=50
ServerKeepAliveTimeout=0
3DDepth=10
AutoSortDownloads=0
ShowInfoOnCatTabs=0
ShowRatesOnTitle=0
VerticalToolbar=0
SeeShare=2
IPFilterAutoLoad=1
IPFilterURL=
FilterLevel=127
FilterLanIPs=1
OnlineSignature=0
OnlineSignatureUpdate=5
OSDirectory=/home/ihmselbst/.aMule/
FilterMessages=0
FilterAllMessages=0
MessagesFromFriendsOnly=0
MessageFromValidSourcesOnly=1
FilterWordMessages=0
MessageFilter=
VerboseDebug=0
Language=
SplitterbarPosition=75
YourHostname=
DateTimeFormat=%A, %x, %X
IndicateRatings=1
AllcatType=0
ShowAllNotCats=0
DisableKnownClientList=0
DisableQueueList=0
MaxMessageSessions=50
PermissionsFiles=416
PermissionsDirs=488
Address=
StatColor0=4194304
StatColor1=16761024
StatColor2=8454016
StatColor3=53760
StatColor4=32768
StatColor5=8421631
StatColor6=200
StatColor7=140
StatColor8=16750230
StatColor9=12583104
StatColor10=8454143
StatColor11=0
StatColor12=8454016
StatColor13=53760
StatColor14=32768
TableSortingServer=0
TableWidthsServer=150,140,25,150,25,40,45,60,40,40,80
TableSortingDownload=0
TableWidthsDownload=260,60,65,65,65,170,50,55,70,110,220,220
TableSortingUploads=0
TableWidthsUploads=150,275,100,60,65,60,60,110,100,100,100
TableSortingShared=0
TableWidthsShared=250,100,50,70,220,100,100,120,120,120,220
[FakeCheck]
Browser=0
CustomBrowser=
BrowserTab=1
[ExternalConnect]
UseSrcSeeds=0
ShowPercent=0
ShowProgressBar=1
AcceptExternalConnections=0
ECAddress=
ECPort=4712
ECPassword=
IpFilterOn=1
UseSecIdent=1
[Statistics]
MaxClientVersions=0
TotalDownloadedBytes=0
TotalUploadedBytes=0
[SkinGUIOptions]
UseSkinFile=0
SkinFile=
[Razor_Preferences]
FastED2KLinksHandler=1
NoNeededSourcesHandling=2
FullQueueSources=0
HighQueueRankingSources=0
HighQueueRanking=1200
AutoDropTimer=240
MAIN_X_POS=217
MAIN_Y_POS=100
MAIN_X_SIZE=800
MAIN_Y_SIZE=600
SRV_SPLITTER_POS=463
[WebServer]
Enabled=0
Port=4711
PageRefreshTime=120
UseGzip=1
UseLowRightsUser=0
Password=
PasswordLow=
Template=
[Proxy]
ProxyEnableProxy=0
ProxyType=0
ProxyName=
ProxyPort=1080
ProxyEnablePassword=0
ProxyUser=
ProxyPassword=
[GUI]
[GUI/TransferWnd]
Splitter=114
ShowClientList=1
</pre>

Remote.conf file

2006-12-17T16:23:53Z

Colin: =Description=

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

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

AMuleWeb

2006-12-17T16:21:33Z

Colin: =Configuring aMuleWeb= link

'''aMuleWeb''' is a utility that allows you to control aMule by means of a web browser from any location. The web interface offers a subset of aMule functionality, including searching for files, initializing downloads, and viewing your download queue. It also displays status information and allows you to change certain options.

aMule itself doesn't support [http://www.w3.org/MarkUp HTTP] connections; aMuleWeb, which does, therefore serves as an intermediary between aMule and a web browser. Once the link between aMuleWeb and a remote user is established, it connects to aMule via the [[External Connections]] interface.

By default, aMuleWeb listens for HTTP connections at port 4711, but this can be changed in [[Usage Preferences|Preferences]]'.

== Installing aMuleWeb ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, aMuleWeb will be included in the installation.

This is the easiest and preferred method of installing aMule and aMuleWeb.

== Compiling aMuleWeb ==

If you have not installed aMule by means of a package, you will need to compile it from source.

aMuleWeb is not compiled separately; it is compiled at the same time you compile aMule by using the ''--enable-amuleweb'' flag when you run ''configure''. (See the [[Main Page]] for links to pages on compiling aMule for various operating systems).

== Configuring aMuleWeb ==

To use aMuleWeb, you first need to set several opions in aMule's Preferences notebook. On the "Remote Controls" page, you will need to:

* Enable "Accept External Connections".
* Enter a password for External Connections.
* Enable webserver

You can also modifiy the default aMuleWeb port (4711) and External Connections port (4712) here as well, but if you do so, you will need to restart aMule for the changes to take effect.

(If you are running aMuled and don't want to use aMule to configure aMuleWeb, see the instructions below)

Next, you need to do is generate [[remote.conf]], the file where aMuleWeb stores its configuration information. (It can be found in the .aMule directory.) Among other things, this file contains the port number which aMule uses for External Connections as well as the password needed to access aMule.

To create a ''remote.conf'' file, enter at the command line:

$ amuleweb -w

aMuleWeb will read the necessary configuration information from amule.conf and generate a ''remote.conf'' file, then exit.

Then start aMuleWeb normally:

$ amuleweb

You should now be able to open aMuleWeb in a browser by entering the URL (on the local system):

http://localhost:4711

or, the with computer's hostname (locally or remote):

http://hostname:4711:

If you want to run aMuleWeb on a different computer than aMule, just copy ''remote.conf'' to the .aMule directory on that computer, and change the hostname line accordingly.

'''NOTE:''' aMuleWeb uses cookies to store session information. Make sure that cookies are enabled in your browser.

== Launching aMuleWeb ==

There are two options for launching aMuleWeb.

First, and preferred, is to enable aMuleWeb activation in aMule's preferences. When started, aMule (or aMuled) will launch amuleweb. Upon exit, aMuleWeb will be automatically terminated.

The second option is to run aMuleWeb manually by entering the "amuleweb" command in terminal.

== Configuring aMuleWeb with aMuled ==

First, if aMuled is running, shut it down.

Then run:

$ amuleweb -w

to generate a ''remote.conf'' file. You will need to edit these options in the [ExternalConnect] section:

*''AcceptExternalConnections=1'' <-- To enable External Connections.

*''ECPassword=ca3c365274907c6fd527068788e14639'' <-- MD5 string

You can then restart amuled and amuleweb.

'''NOTE:''' Passwords must be md5sum format. To generate an MD5sum for your password, run:
:''$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1''
:''ca3c365274907c6fd527068788e14639''

'''Note'''If you get ''FATAL ERROR: Cannot find template: default'' it's because you didn't run ''make install''. If you don't want to install aMule, copy the ''src/webserver/default/'' directory into ''~/.aMule/webserver/'' (create it if needed). If you want any other template (probably ''php-default''), copy it too. Then go back to the previous step.

=== aMuleWeb with older versions of aMule ===

For instructions for using aMuleWeb with aMule pre-2.0.0 final, see [[Webserver-old|this page]] for archived material.

== Standard ports ==

The ports can be set to anything, but by default aMule uses:

*External Connections: 4712
*amuleweb: 4711

Make sure you do not confuse the two; in the default configuration, it looks like this:

aMule --> [4712] --> aMuleWeb --> [4711] --> web browser

== Template (skin) location ==

aMuleWeb looks for its files in a number of places:

*In your home directory: ''$HOME/.aMule/webserver/''[skin name]''/''

*And at its install location, in this order (by default, ''/usr/local/share/amule/webserver'' if you compiled aMule, or ''/usr/share/amule/webserver'' if you installed it from a package).

Default template name is 'default'.

If, ''after installing'' aMule, aMuleWeb refuses to run because of not being able to load template:

*Please report this situation to us, and then

*Create the directories ''webserver/default'' in the ''.aMule'' subdirectory of your home directory, and copy the contents of the ''src/webserver'' directory there from the aMule tarball (ie, ''$HOME/.aMule/webserver/default'').

== aMuled and aMuleWeb as services ==

Although starting aMuleWeb by enabling it inaMule's preferences is the preferred method, you can also run aMuleWeb together with aMuled as as services by means of an init.d script. Here is an example:

''/etc/init.d/amule''

PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
DAEMON=/usr/bin/amuled
WEB=/usr/bin/amuleweb
NAME=amuled
DESC=amuled
RUNAMULE=no
USER=youramuleuser

test -x $DAEMON || exit 0

# Include amule defaults if available
if [ -f /etc/default/amule ] ; then
. /etc/default/amule
fi

if [ "$RUNAMULE" != "yes" ];then
echo "Amule not to be started. Edit /etc/default/amule first."
exit 1
fi

set -e

case "$1" in
start)
echo -n "Starting $DESC: "
su $USER -c "$DAEMON -f"
while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
su $USER -c "$WEB --quiet &"
echo "$NAME."
;;
stop)
echo -n "Stopping $DESC: "
killall --quiet --ignore-case $WEB
killall --quiet --ignore-case $DAEMON
echo "$NAME."
;;
restart|force-reload)
echo -n "Restarting $DESC: "
killall --quiet --ignore-case $WEB
killall --quiet --ignore-case $DAEMON
sleep 1
su $USER -c "$DAEMON -f"
while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
su $USER -c "$WEB --quiet &"
echo "$NAME."
;;
*)
N=/etc/init.d/$NAME
echo "Usage: $N {start|stop|restart|force-reload}" >&2
exit 1
;;
esac

exit 0

Then just set that script to be run at start up. On [[Debian]] this would be doen with the following command:

update-rc.d amule defaults

Then, for the daemons to start you just have to create a file ''/etc/default/amule'' which contains a single line:

RUNAMULE=yes

== Template language and development ==

Simply put, aMuleWeb templates are ordinary HTML files. In order to make them "interactive", server-side language is embedded inside. This language is scaled down dialect of PHP. More detailed information can be found on [[aMuleWeb_PHP]].

== Where to report problems and questions? ==

For Problems or Questions just report on http://forum.amule.org forum or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

== Other sources of information ==

Read the aMuleWeb man page, which is available in English, French, German, Hungarian and Spanish.

For further information read the [[FAQ_webserver|aMuleWeb FAQ]].

Remote.conf

2006-12-17T16:20:28Z

Colin: redirect

#REDIRECT [[Remote.conf_file]]

Amule.conf

2006-12-17T16:17:40Z

Colin: redirect

#REDIRECT [[Amule.conf file]]

Events

2006-12-17T16:12:42Z

Colin: =Syntax=

User:Colin

2006-12-17T15:09:10Z

Colin: fxs

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro

and other smaller fixes elsewhere...

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "colin.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the "amule-cvs" directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type
"yum install oorexx". For Ubuntu, type "apt-get install rexx-regina". Other distros probably have Rexx in their repositories under one name or another.

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

User:Colin

2006-12-17T15:05:31Z

Colin: fxs

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro

and other smaller fixes elsewhere...

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "colin.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the '''../amule-cvs''' directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type '''yum install oorexx'''.
For Ubuntu, type '''apt-get install rexx-regina'''. Other distros probably have Rexx in their repositories under one name or another.

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

User:Colin

2006-12-17T15:04:40Z

Colin: fxs

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AmuleWeb]] and rewrote the intro

and other smaller fixes elsewhere...

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "colin.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the '''../amule-cvs''' directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type '''yum install oorexx'''.
For Ubuntu, type '''apt-get install rexx-regina'''. Other distros probably have Rexx in their repositories under one name or another.

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

User:Colin

2006-12-17T15:00:12Z

Colin: fxs

Satisfied amule customer since sept. 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

So far, I have created the [[Events]] pages with the example script.

----

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
/*bin/true;exec rexx "$0" "$@";exit # REXX */

/* --------- amuleCVSfx --------- */

/*
run this script in ../amule-cvs
It will modify src/amule.cpp and save the
original at src/amule.cpp~
*/

FileIn = "src/amule.cpp"
FileOut = "colin.tmp"
Found = 0

do while lines(FileIn) > 0
OneLine = lineIn(FileIn)
if pos("!cmdline.Found",OneLine) > 1 & Found <> 1 then
do
call LineOut FileOut, "// ------ Commented out by amuleCVSfx ------ "
call LineOut FileOut, "//" OneLine
do i = 0 to 4
OneLine = lineIn(FileIn)
call LineOut FileOut, "//" OneLine
i = i + 1
end
Found = 1
end
else
call LineOut FileOut, OneLine
end
if Found = 1 then
do
"mv -f" FileIn FileIn || '~' "2>&1"
"mv -f" FileOut FileIn "2>&1"
say "Fixed!"
end
else
do
say "Not found"
"rm -f" FileOut
end
return
</pre>

You need to run it in the '''../amule-cvs''' directory before issuing the "make" command.

It is written in '''Rexx''', so you will need to have a Rexx interpreter on your system to run it. To install Rexx in Fedora, type '''yum install oorexx'''.
For Ubuntu, type '''apt-get install rexx-regina'''. Other distros probably have Rexx in their repositories under one name or another.

I originally wrote it as a shell script, but file I/O works much better in Rexx, which is designed for this kind of thing.

AMuleWeb

2006-12-17T14:43:28Z

Colin: reorg, grammar & spelling

'''aMuleWeb''' is a utility that allows you to control aMule by means of a web browser from any location. The web interface offers a subset of aMule functionality, including searching for files, initializing downloads, and viewing your download queue. It also displays status information and allows you to change certain options.

aMule itself doesn't support [http://www.w3.org/MarkUp HTTP] connections; aMuleWeb, which does, therefore serves as an intermediary between aMule and a web browser. Once the link between aMuleWeb and a remote user is established, it connects to aMule via the [[External Connections]] interface.

By default, aMuleWeb listens for HTTP connections at port 4711, but this can be changed in [[Usage Preferences|Preferences]]'.

== Installing aMuleWeb ==

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, aMuleWeb will be included in the installation.

This is the easiest and preferred method of installing aMule and aMuleWeb.

== Compiling aMuleWeb ==

If you have not installed aMule by means of a package, you will need to compile it from source.

aMuleWeb is not compiled separately; it is compiled at the same time you compile aMule by using the ''--enable-amuleweb'' flag when you run ''configure''. (See the [[Main Page]] for links to pages on compiling aMule for various operating systems).

== Configuring aMuleWeb ==

To use aMuleWeb, you first need to set several opions in aMule's Preferences notebook. On the "Remote Controls" page, you will need to:

* Enable "Accept External Connections".
* Enter a password for External Connections.
* Enable webserver

You can also modifiy the default aMuleWeb port (4711) and External Connections port (4712) here as well, but if you do so, you will need to restart aMule for the changes to take effect.

(If you are running aMuled and don't want to use aMule to configure aMuleWeb, see the instructions below)

Next, you need to do is generate ''remote.conf'', the file where aMuleWeb stores its configuration information. (It can be found in the .aMule directory.) Among other things, this file contains the port number which aMule uses for External Connections as well as the password needed to access aMule.

To create a ''remote.conf'' file, enter at the command line:

$ amuleweb -w

aMuleWeb will read the necessary configuration information from amule.conf and generate a ''remote.conf'' file, then exit.

Then start aMuleWeb normally:

$ amuleweb

You should now be able to open aMuleWeb in a browser by entering the URL (on the local system):

http://localhost:4711

or, the with computer's hostname (locally or remote):

http://hostname:4711:

If you want to run aMuleWeb on a different computer than aMule, just copy ''remote.conf'' to the .aMule directory on that computer, and change the hostname line accordingly.

'''NOTE:''' aMuleWeb uses cookies to store session information. Make sure that cookies are enabled in your browser.

== Launching aMuleWeb ==

There are two options for launching aMuleWeb.

First, and preferred, is to enable aMuleWeb activation in aMule's preferences. When started, aMule (or aMuled) will launch amuleweb. Upon exit, aMuleWeb will be automatically terminated.

The second option is to run aMuleWeb manually by entering the "amuleweb" command in terminal.

== Configuring aMuleWeb with aMuled ==

First, if aMuled is running, shut it down.

Then run:

$ amuleweb -w

to generate a ''remote.conf'' file. You will need to edit these options in the [ExternalConnect] section:

*''AcceptExternalConnections=1'' <-- To enable External Connections.

*''ECPassword=ca3c365274907c6fd527068788e14639'' <-- MD5 string

You can then restart amuled and amuleweb.

'''NOTE:''' Passwords must be md5sum format. To generate an MD5sum for your password, run:
:''$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1''
:''ca3c365274907c6fd527068788e14639''

'''Note'''If you get ''FATAL ERROR: Cannot find template: default'' it's because you didn't run ''make install''. If you don't want to install aMule, copy the ''src/webserver/default/'' directory into ''~/.aMule/webserver/'' (create it if needed). If you want any other template (probably ''php-default''), copy it too. Then go back to the previous step.

=== aMuleWeb with older versions of aMule ===

For instructions for using aMuleWeb with aMule pre-2.0.0 final, see [[Webserver-old|this page]] for archived material.

== Standard ports ==

The ports can be set to anything, but by default aMule uses:

*External Connections: 4712
*amuleweb: 4711

Make sure you do not confuse the two; in the default configuration, it looks like this:

aMule --> [4712] --> aMuleWeb --> [4711] --> web browser

== Template (skin) location ==

aMuleWeb looks for its files in a number of places:

*In your home directory: ''$HOME/.aMule/webserver/''[skin name]''/''

*And at its install location, in this order (by default, ''/usr/local/share/amule/webserver'' if you compiled aMule, or ''/usr/share/amule/webserver'' if you installed it from a package).

Default template name is 'default'.

If, ''after installing'' aMule, aMuleWeb refuses to run because of not being able to load template:

*Please report this situation to us, and then

*Create the directories ''webserver/default'' in the ''.aMule'' subdirectory of your home directory, and copy the contents of the ''src/webserver'' directory there from the aMule tarball (ie, ''$HOME/.aMule/webserver/default'').

== aMuled and aMuleWeb as services ==

Although starting aMuleWeb by enabling it inaMule's preferences is the preferred method, you can also run aMuleWeb together with aMuled as as services by means of an init.d script. Here is an example:

''/etc/init.d/amule''

PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
DAEMON=/usr/bin/amuled
WEB=/usr/bin/amuleweb
NAME=amuled
DESC=amuled
RUNAMULE=no
USER=youramuleuser

test -x $DAEMON || exit 0

# Include amule defaults if available
if [ -f /etc/default/amule ] ; then
. /etc/default/amule
fi

if [ "$RUNAMULE" != "yes" ];then
echo "Amule not to be started. Edit /etc/default/amule first."
exit 1
fi

set -e

case "$1" in
start)
echo -n "Starting $DESC: "
su $USER -c "$DAEMON -f"
while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
su $USER -c "$WEB --quiet &"
echo "$NAME."
;;
stop)
echo -n "Stopping $DESC: "
killall --quiet --ignore-case $WEB
killall --quiet --ignore-case $DAEMON
echo "$NAME."
;;
restart|force-reload)
echo -n "Restarting $DESC: "
killall --quiet --ignore-case $WEB
killall --quiet --ignore-case $DAEMON
sleep 1
su $USER -c "$DAEMON -f"
while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
su $USER -c "$WEB --quiet &"
echo "$NAME."
;;
*)
N=/etc/init.d/$NAME
echo "Usage: $N {start|stop|restart|force-reload}" >&2
exit 1
;;
esac

exit 0

Then just set that script to be run at start up. On [[Debian]] this would be doen with the following command:

update-rc.d amule defaults

Then, for the daemons to start you just have to create a file ''/etc/default/amule'' which contains a single line:

RUNAMULE=yes

== Template language and development ==

Simply put, aMuleWeb templates are ordinary HTML files. In order to make them "interactive", server-side language is embedded inside. This language is scaled down dialect of PHP. More detailed information can be found on [[aMuleWeb_PHP]].

== Where to report problems and questions? ==

For Problems or Questions just report on http://forum.amule.org forum or join [[IRC]] channel [irc://irc.freenode.net/amule #amule] at [irc://irc.freenode.net irc.freenode.net]

== Other sources of information ==

Read the aMuleWeb man page, which is available in English, French, German, Hungarian and Spanish.

For further information read the [[FAQ_webserver|aMuleWeb FAQ]].

Log

2006-12-17T12:53:29Z

Colin: lnk

A log is usually a [[file]] containing a record of chronological information about something happenning.

aMule's log is called [[logfile]] and is stored with aMule's other settings in the ./aMule directory. It is a text file which you can view with "more", "less", or any other text file viewer.

===External link===
* [http://en.wikipedia.org/wiki/Data_logging Wikipedia's log article].

Logfile

2006-12-17T12:51:00Z

Colin: rm (There is currently no text in this page)

The '''logfile''' is where aMule records important information about its status and actions. The logfile is displayed in the lower window on the Network page of aMule, where it is updated continually.

The logfile is stored with aMule's other settings in the ./aMule directory. It is a text file which you can view outside of aMule with "more", "less", or any other text file viewer.

When aMule starts, it creates a new log. The previous log is stored as "logfile.bak".

Logfile

2006-12-17T12:49:38Z

Colin: new entry

(There is currently no text in this page)
The '''logfile''' is where aMule records important information about its status and actions. The logfile is displayed in the lower window on the Network page of aMule, where it is updated continually.

The logfile is stored with aMule's other settings in the ./aMule directory. It is a text file which you can view outside of aMule with "more", "less", or any other text file viewer.

When aMule starts, it creates a new log. The previous log is stored as "logfile.bak".

Events

2006-12-17T12:40:15Z

Colin: + amule.conf