AMule Project FAQ - User contributions [en]

Webcache

2004-11-01T18:42:23Z

80.224.220.194:

== Description ==

The idea if webcache is to upload the shared data into an ISP proxy and leave it there for other [[client]]s to download it.

The whole webcache description can be found with full details in the [http://forum.emule-project.net/index.php?showtopic=14768 original post]. Plus, there are lot's of additional documentation pages all around the net, where [http://www.google.com Google] is your friend ;)

== History ==

This all began on 13th April 2003 at [http://forum.emule-project.net eMule's forums] when [mailto:sufcrusher@zonnet.nl sufcrusher] posted [http://forum.emule-project.net/index.php?showtopic=14768 this post]. The whole history can be followed there up to the first [[eMule]] mods implementing it.

== Pros and cons ==

=== Pros ===

* The most evident pro, and the main purpose of it, is that web proxies use to have lots of bandwidth and very high speeds so the data sharing speeds should be greatly boosted.

* Also, [[P2P]] [[client]]s use to generate heavy traffic on ISPs since it creates and destroys lots of connections in very little time and get/send large amounts of data. Using webcache would stop this connections from going through the ISPs since they would only get to the ISPs' proxies.

=== Cons ===

* Since all your data (or some of it) would pass through your ISP's proxy, your ISP would know what you are sharing, so your privacy would suffer very harmfully.

* It is not clear whether using ISPs' web proxies for things other than web data is legal. Even if it was in your country, legislations are different from state to state, so [[client]]s use to conform the largest amount of legislations they possibly can to avoid their users from suffering disgusting experiencies with the law. Also, allthough the webcache feature might be better for your ISP, it can be bad if the traffic is too high, so you might have your ISP from braking the contract with you and so, leaving you without connection.

* The [[P2P]] networks are being heavily tracked by some governments since they believe they are used for illegal purposes. There is a popular sentence: "if it works, leave it as it is". Well, apply it here.

== Implementing webcache ==

There are already some [[client]]s out there supporting webcache. Most of them are [[eMule]] mods. We'd like to advise that we do '''NOT''' recommend at all to use them. This mods bring down the [[P2P]] reputation and by using them you contribute in doing so.

== Regarding [[aMule]] ==

Discussions about implementing webcache feature into [[aMule]] have appeared many times in [http://forum.amule.org aMule's forums] although maybe the most relevant is [http://www.amule-project.net/amule/thread.php?threadid=3513 this one].

Anyway, until further (rare to ever-happen) news, neither [[aMule]] nor [[eMule]] are going to officially support webcache in any future release.

External Connections

2004-11-01T17:30:48Z

80.224.220.194:

External Connections is the ''bi-directional'' way [[aMule]] has to communicate with external utilities, like the [[aMuleWeb]] and [[aMuleCMD]]. So, when a user is controlling [[aMule]] remotely, it is sending the commands through the External Conections port and [[aMule]] is reading them there (when controlling through a web browser, what is really happening is that [[aMuleWeb]] is getting the actions, interpreting them and sending the commands to the External Connection ports).

If both [[aMule]] and their utilities run on the same machine, there's no need to redirect the External Connections port in a [[Firewall]]ed environment (NAT network with a router, etc...). If you had to connect to the External Connections port from somewhere out of the network, it would be necessary to configure the router/[[Firewall]]/etc properly to accept connections through the External Connection port (this would happen, for example, connecting through [[aMuleCMD]] from somewhere outside the network).

As of [[aMule]] 2.0.0-rc8, External Connections reached [[ECv2|version 2.0]]. This version is a complete rewrite of the protocol and is '''NOT''' backwards compatible, so it is heavily suggested to upgreade to both a server (that is [[aMule]]) and [[client]] supporting it. Information about [[ECv2|External Connections v2]] can be reached [[ECv2|here]].

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

External Connections

2004-11-01T17:30:26Z

80.224.220.194:

External Connections is the ''bi-directional'' way [[aMule]] has to communicate with external utilities, like the [[aMuleWeb]] and [[aMuleCMD]]. So, when a user is controlling [[aMule]] remotely, it is sending the commands through the External Conections port and [[aMule]] is reading them there (when controlling through a web browser, what is really happening is that [[aMuleWeb]] is getting the actions, interpreting them and sending the commands to the External Connection ports).

If both [[aMule]] and their utilities run on the same machine, there's no need to redirect the External Connections port in a [[Firewall]]ed environment (NAT network with a router, etc...). If you had to connect to the External Connections port from somewhere out of the network, it would be necessary to configure the router/[[Firewall]]/etc properly to accept connections through the External Connection port (this would happen, for example, connecting through [[aMuleCMD]] from somewhere outside the network).

As of [[aMule]] rc8, External Connections reached [[ECv2|version 2.0]]. This version is a complete rewrite of the protocol and is '''NOT''' backwards compatible, so it is heavily suggested to upgreade to both a server (that is [[aMule]]) and [[client]] supporting it. Information about [[ECv2|External Connections v2]] can be reached [[ECv2|here]].

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

Dependencies

2004-11-01T17:23:47Z

80.224.220.194:

== Current dependencies ==
The following libraries are requiered by [[aMule]]:

* [[wxWidgets]]
* [http://curl.haxx.se Curl]
* [[Libgd|LibGD]]

== Old dependencies ==
The following libraries where requiered by [[aMule]] sometime in the past, but are no longer required:

* [[libcrypto|LibCrypto++]] (Necessary parts are currently merged into [[aMule]]'s code)

Dependencies

2004-11-01T17:22:44Z

80.224.220.194:

The following libraries are requiered by [[aMule]]:

* [[wxWidgets]]
* [http://curl.haxx.se Curl]
* [[Libgd|LibGD]]

== Old dependencies ==
The following libraries where requiered by [[aMule]] sometime in the past, but are no longer required:

* [[libcrypto|LibCrypto++]]

HowTo compile on Mac

2004-11-01T17:18:15Z

80.224.220.194:

The following is the commands you should type to install [[aMule]] on [http://www.apple.com/macosx MacOS X]. 
This HowTo is written to install [[aMule]] cvs but should work for any other version. Please note that you should always download the latest [[aMule]] version available. 
Whenever ''[http://curl.haxx.se curl]'' is used, if it isn't installed on your system, just download the file manually.
Lines beginning with a ''#'' character are comments on what the following lines do.

''<pre>
# install Xcode Tools
# http://developer.apple.com/tools/download/
# Getting ADC ID > Log In > Download Software > Developer Tools > Download Xcode Tools last release > Install

# install Fink too, since gettext is needed
# http://fink.sourceforge.net
# read the info at http://fink.sourceforge.net/download to learn how to install gettext

# make amule dir in home
cd ~
mkdir amule
cd amule

# get source from the internet and unpack it
curl -O http://heanet.dl.sourceforge.net/sourceforge/wxwindows/wxMac-2.5.3.tar.gz
curl -O http://download.berlios.de/amule/aMule-2.0.0rc7.tar.bz2
tar -xzf wxMac-2.5.3.tar.gz
tar -xjf aMule-2.0.0rc7.tar.bz2

# remove downloaded archives after unpacking
rm wxMac-2.5.3.tar.gz aMule-2.0.0rc7.tar.bz2

# install wxMac
cd wxMac-2.5.3
# directory "build" should already be there. if not, create it with
# "mkdir build":
cd build
../configure
make
sudo make install
cd ..
cd ..

# compile aMule
cd aMule-2.0.0rc7
./configure --disable-systray --disable-gtk --enable-embedded_crypto --with-wx-prefix=/usr/local --with-wx-config=/usr/local/bin/wx-config
make

# optional: reduce size of amule from 44 MB to 3 MB while loosing
# debug info :-(
strip src/amule

cd ..

# create app-Container
curl -O http://download.berlios.de/amule/aMule-App-Container.tar.bz2
tar -xjf aMule-App-Container.tar.bz2
rm aMule-App-Container.tar.bz2
# the following line is just in case the app container failed to extract
mkdir -p amule.app/Contents/MacOS/
cp aMule-2.0.0rc7/src/amule amule.app/Contents/MacOS/

# move amule to your Applications folder
mv amule.app /Applications

</pre>''

If you get an error like this: ''You cannot open the application "amule" because it may be
damaged or incomplete'', right click on ''amule'' then click on ''Show Packages Contents'',
go to Contents>MacOS> and double click on ''amule''.
Next time you start from ''amule.app'' it will run fine.
If you still get the same error, move ''amule.app'' to the desktop and run it from there.

HowTo compile on Mac

2004-11-01T17:13:55Z

80.224.220.194:

The following is the commands you should type to install [[aMule]] on [http://www.apple.com/macosx MacOS X]. 
This HowTo is written to install [[aMule]] cvs but should work for any other version. Please note that you should always download the latest [[aMule]] version available. 
Whenever ''[http://curl.haxx.se curl]'' is used, if it isn't installed on your system, just download the file manually.
Lines beginning with a ''#'' character are comments on what the following lines do.

''<pre>
# install Xcode Tools
# http://developer.apple.com/tools/download/
# Getting ADC ID > Log In > Download Software > Developer Tools > Download Xcode Tools last release > Install

# install Fink too, since gettext is needed
# http://fink.sourceforge.net
# read the info at http://fink.sourceforge.net/download to learn how to install gettext

# make amule dir in home
cd ~
mkdir amule
cd amule

# get source from the internet and unpack it
curl -O http://heanet.dl.sourceforge.net/sourceforge/wxwindows/wxMac-2.5.3.tar.gz
curl -O http://download.berlios.de/amule/aMule-2.0.0rc7.tar.bz2
tar -xzf wxMac-2.5.3.tar.gz
tar -xjf aMule-2.0.0rc7.tar.bz2

# remove downloaded archives after unpacking
rm wxMac-2.5.3.tar.gz aMule-2.0.0rc7.tar.bz2

# install wxMac
cd wxMac-2.5.3
# directory "build" should already be there. if not, create it with
# "mkdir build":
cd build
../configure
make
sudo make install
cd ..
cd ..

# compile aMule
cd aMule-2.0.0rc7
./configure --disable-systray --disable-gtk --enable-embedded_crypto --with-wx-prefix=/usr/local --with-wx-config=/usr/local/bin/wx-config
make

# optional: reduce size of amule from 44 MB to 3 MB while loosing
# debug info :-(
strip src/amule

cd ..

# create app-Container
curl -O http://download.berlios.de/amule/aMule-App-Container.tar.bz2
tar -xjf aMule-App-Container.tar.bz2
rm aMule-App-Container.tar.bz2
mkdir -p amule.app/Contents/MacOS/
cp aMule-2.0.0rc7/src/amule amule.app/Contents/MacOS/

# move amule to your Applications folder
mv amule.app /Applications

</pre>''

If you get an error like this: ''You cannot open the application "amule" because it may be
damaged or incomplete'', right click on ''amule'' then click on ''Show Packages Contents'',
go to Contents>MacOS> and double click on ''amule''.
Next time you start from ''amule.app'' it will run fine.
If you still get the same error, move ''amule.app'' to the desktop and run it from there.

Libgd

2004-11-01T17:08:33Z

80.224.220.194:

[http://www.boutell.com/gd LibGD] is a graphics library (that is, a library which's target is graphic creation and manipulation).

It is used by [[aMule]] allthough it is not required. When compiling [[aMule]], ''configure'' will search for [http://www.boutell.com/gd LibGD]. If it finds it, it will use it and compile normally. If it doesn't find it, two features will be disabled:

* [[aMuleWeb]] will not generate statistic graphics.
* [[CAS]] will not accept the ''-o'' option in the command line entry (this option enables [[CAS]] to generate statistic graphs).

Libgd

2004-11-01T17:08:12Z

80.224.220.194:

[http://www.boutell.com/gd LibGD] is a graphics library (that is, a library which's target is graphic creation and manipulation).

It is used by [[aMule]] allthough it is not required. WHen compiling [[aMule]], ''configure'' will search for [http://www.boutell.com/gd LibGD]. If it finds it, it will use it and compile normally. If it doesn't find it, two features will be disabled:

* [[aMuleWeb]] will not generate statistic graphics.
* [[CAS]] will not accept the ''-o'' option in the command line entry (this option enables [[CAS]] to generate statistic graphs).

Ed2k links handling

2004-10-31T22:03:49Z

80.224.220.194:

The way to have [[aMule]] handle your [[ed2k links]] on your favorite WebBrowser will depend on which WebBrowser you use. So, here's a list of mini-HowTos for each of the most popular WebBrowsers.
Have in mind that everywhere on this document, ''/path/to/ed2k'' should be replaced with ''/usr/local/bin/ed2k'', ''/usr/bin/ed2k'', ''C:\Program Files\aMule\ed2k.exe'' or whatever, depending on your own system's configuration.

As a general idea, in most [http://www.kernel.org Linux] systems, self-compiled [[aMule]]s will install the [[FAQ_ed2k|ed2k]] utility in ''/usr/local/bin/ed2k'', while package-installed [[aMule]]s will install it in ''/usr/bin/ed2k''. As an exception, it is known that [http://www.suse.com SuSE] packages install it in ''/usr/local/bin/ed2k''.

== [http://www.microsoft.com/windows/ie Internet Explorer] ==
'''by ''[[User:Jacobo221|Jacobo221]]'''''

Go to "Start" -> "Run" and run "regedit" (without quotes).
Now, in regedit, get to ''HKEY_LOCAL_MACHINE\SOFTWARE\Classes\ed2k\shell\open'' 
It could happen that ''ed2k'' didn't exist. In such case, create it by selecting "New" -> "Key" and entering ''ed2k'' as value. Then do the same with ''shell'' and ''open''. 
Once inside the ''open'' key, if ''command'' exists, just double click on it, but if it doesn't, go to "New" -> "Value" and enter the path to the ed2k application as an ASCII string value, followed by ''"%1"'' (with quotes), so you should end with some value like ''C:\Program Files\aMule2\ed2k "%1"''.

== [http://www.konqueror.org Konqueror] ==
'''by ''gfdsa'''''

''/usr/kde/3.1/share/services'' you can find it by file names ended with ''.protocol'' kinda ''`find /usr -name "*.protocol"`'' or ''`find /opt -name "*.protocol"`'' or even put ''/'' to path if you want.

If the search was successful, create a file named like ''ed2k.protocol'' in
the mentioned directory:

<code>[Protocol] 
exec=/path/to/ed2k "%u" 
protocol=ed2k 
input=none 
output=none 
helper=true 
listing=false 
reading=false 
writing=false 
makedir=false 
deleting=false</code>

Now just restart [http://www.konqueror.org Konqueror].

== [http://www.opera.com Opera] ==
'''by ''thermoman [Marcel Meckel]'', ''ender'' and ''[[User:Jacobo221|Jacobo221]]''

Edit ''/etc/opera6rc'' as root or ''~/.opera/opera6.ini'' as non-root:

<code>[User Prefs] 
TrustedExternalURLProtocols=ed2k

[Trusted Applications] 
ed2k=/path/to/ed2k ed2k://%u</code>

Or an easier way: 
open ''Tools->Preferences->Paths and Programms->Add...'' 
protocol = ed2k 
choose the path: ''/path/to/ed2k''

'''[http://www.opera.com Opera] 6''' doesn't pass complete URL to external programs; only URL without protocol. The way to walk around this follows.

In [http://www.kernel.org Linux] or some other Unix-like flavour 
Create ''amule_submit.sh'' with this content:

<code>#!/bin/sh 
/path/to/ed2k "ed2k://$1"</code>

Change ''ed2k=/path/to/ed2k ed2k://%u'' with ''ed2k=/path/to/amule_submit.sh ed2k://%u''

In Windows systems 
Crate ''amule_submit.bat'' with this content:

''X:\path\to\ed2k.exe "ed2k://%1"''

Change ''ed2k=/path/to/ed2k ed2k://%u'' with ''ed2k=X:\path\to\amule_submit.bat ed2k://%u''

== [http://www.mozilla.org Mozilla] 1.7 (or later) & [http://www.mozilla.org/products/firefox Firefox] 0.9 ==
'''by ''GhePeU'''''

Mozex doesn't work anymore with [http://www.mozilla.org Mozilla] 1.7 and [http://www.mozilla.org/products/firefox Firefox] 0.9. There is an alternate method that seems to be working with both of them:

*Remove [http://mozex.mozdev.org/installation.html MozEx] if installed or at least remove the ed2k input from it (only if [http://mozex.mozdev.org/installation.html MozEx] is installed)

*Insert ''about:config'' in the address bar

*Right click on the list, select '''New''', then '''Boolean'''; insert ''network.protocol-handler.external.ed2k'' as '''Preference Name''' and ''true'' as '''Value'''

*Now another right click, select '''New''' and '''String'''; insert ''network.protocol-handler.app.ed2k'' as '''Preference Name''' and ''/path/to/ed2k'' (or path to where the file is installed on you system) as '''Value'''.

== [http://www.mozilla.org Mozilla] 1.3 to 1.6 & [http://www.mozilla.org/products/firefox Firebird] v0.6 & [http://www.mozilla.org/products/firefox Firefox] v0.8 ==
'''by ''DeltaHF'''''

Go to [http://mozex.mozdev.org/installation.html MozEx's WebPage] and install the ''mozex-1.07.xpi'' file. 
Restart your [http://www.mozilla.org Mozilla]/[http://www.mozilla.org/products/firefox FireBird]/[http://www.mozilla.org/products/firefox FireFox], go to Edit -> Preferences -> mozex -> ED2K and set it to ''/path/to/ed2k %r'' 
Click '''OK''' and you're done.

Note for Firefox 0.8 users 
Instead of Edit -> Preferences -> mozex -> ED2K, you'll find [http://mozex.mozdev.org/installation.html MozEx]'s preferences at Edit -> Preferences -> Extensions -> mozex -> Options -> ED2K

== [http://www.mozilla.org Mozilla] 1.2.1 or earlier ==
'''by ''rpokorny [R. Pokorny]'''''

1) Go to [http://protozilla.mozdev.org/download.html Protozilla's WebPage] 
Choose the version fitting your [http://www.mozilla.org Mozilla]-version and click on '''Install'''. It will auto-install [http://protozilla.mozdev.org Protozilla]. 
Now close [http://www.mozilla.org Mozilla] completely.

Notes for [http://www.kernel.org Linux] and other Unix-like systems users 
- You must have write permission to the [http://www.mozilla.org Mozilla] installation directory. If you've installed [http://www.mozilla.org Mozilla] in ''/usr'', you'll have to be '''root''' probably. 
- The downloadable precompiled version of [http://protozilla.mozdev.org Protozilla] apparently does '''not''' work with [http://www.debian.org Debian]'s [http://www.mozilla.org Mozilla] packages. It '''does''' work together with the precompiled version of 1.2.1 available at [http://www.mozilla.org Mozilla's WebPage] for example (or you can build both [http://www.mozilla.org Mozilla] and [http://protozilla.mozdev.org Protozilla] yourself).

2) This step is only necessary if you had to start [http://www.mozilla.org Mozilla]/[http://www.mozilla.org/products/firefox FireBird]/[http://www.mozilla.org/products/firefox FireFox] as '''root''' in step 1.

As '''root''' do:
''cp -r /root/.mozilla/PROFILENAME/RANDOM.slt/protozilla/ /home/USERNAME/.mozilla/PROFILENAME2/RANDOM.slt/''

This will have copied protozilla-configuration from root's home directory to user's home directory.

''cd /home/USERNAME/.mozilla/PROFILENAME/RANDOM.slt/
chown -R YOURUSER.YOURGROUP protozilla''

This will have changed file-ownership parameters in user's files.

Note: 
'''USERNAME:''' Name of your normal, non-root user. 
'''PROFILENAME:''' Name of the profile you'll want to use. 
'''RANDOM:''' Random alphanumeric string, autogenerated by mozilla. 
'''YOURUSER, YOURGROUP:''' User and group of your normal user. 

3) Setup a protocol-handler for [[ed2k links]]: 
''cd ~/.mozilla/PROFILENAME/RANDOM.slt/protozilla/protocol''

create a file called ''ed2k.cmd'' with the following content:

''ed2k ed2k:$URI_DATA''

(The file doesn't need to be executable).

Now restart [http://www.mozilla.org Mozilla].

== [http://xray.sai.msu.ru/~karpov/links-hacked Links] ==
(Probably this will work for the usual links and/or [[ed2k links|elinks]], too)

add to ''url.c'' behind the lines about telnet and tn3270:
''--snip''
''{"ed2k", 0, NULL, ed2k_func, 0, 0, 0},''
''--snap''

add to ''links.h'' behind the definitions of /* mailto.c */:
''--snip''
''void ed2k_func(struct session *, unsigned char *);''
''--snap''

add to ''mailto.c'' at the end:
''--snip''
''void ed2k_func(struct session *ses, unsigned char *url)''
''{''
''tn_func(ses, url, options_get("network_program_ed2k"), TEXT(T_ED2K), TEXT(T_BAD_ED2K_URL));''
''}''
''--snap''

add to ''options_register.c'' behind telnet and tn3270:
''--snip''
''register_option_char("network_program_ed2k", TEXT(T_ED2K_PROG),NULL,2);''
''--snap''

add to ''intl/*.lng'' behind
''"T_TN3270_PROG": T_ED2K_PROG, "ed2k program",'' (or whatever that is in your language), behind
''"T_TN3270": T_ED2K, "ed2k",'' and behind
''"T_BAD_TN3270_URL": T_BAD_ED2K_URL'' (I guess you've got the picture)

If you want to automatize this stuff, execute the following commands:
''cd intl''
''for l in *.lng; do''
''cp $l $l.bak''
''cat $l.bak | sed -e "/T_TN3270_PROG*/aT_ED2K_PROG\, \"ed2k program\"\," \''
''-e "/T_TN3270,\ */aT_ED2K\, \"ed2k\"\," \''
''-e "/T_BAD_TN3270_URL*/aT_BAD_ED2K_URL\, \"Bad ed2k url\"\," > $l''
''done''

Anyway, run afterwards before recompiling links-hacked:
''./synclang''
''cd ..''

Now you can compile with
''./configure'' (add your favourite options here) ''&&''
''make &&''
''make install''

Because links somewhat malforms the urls, we need a small bash script handler:
''cat > /usr/bin/ed2k4links.sh << "EOF"''
''#!/bin/bash''
''ed2k $(echo "ed2k://$1" | sed s/_/\|/g)''
''EOF''
''chmod a+x /usr/bin/ed2k4links.sh''

Do not forget to setup links (Options->Network Options->Mail and Telnet Programs) to call our ''ed2k4links.sh'' for [[ed2k links]]:
''ed2k4links.sh %''

Attention: The Percent Mark is important! Now links should work with [[ed2k links]].

== More information ==

If the above information didn't help you enough, take a look at [http://www.amule.org/amule/ed2k.php http://www.amule.org/amule/ed2k.php]

Webcache

2004-10-31T21:54:51Z

80.224.220.194:

Neither [[aMule]] nor [[eMule]] nor any other (most probably) popular [[client]]s will support webcache officially.

While no info is added about this, please read the following link:

http://www.amule-project.net/amule/thread.php?threadid=3513&sid=