Difference between revisions of "External Connections"

From AMule Project FAQ
Jump to: navigation, search
m (Corrected last correction)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
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 Connections 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).
+
<center>'''English''' | [[External_Connections-de|Deutsch]]</center>
  
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).
+
''''External Connections''' (EC) is a bi-directional interface [[aMule]] uses to communicate with external utilities, specifically:
  
As of [[aMule]] 2.0.0-rc8, External Connections reached [[ECv2|version 2.0]] (*cough*). This version is a complete rewrite of the protocol and is '''NOT''' backwards compatible, so it is heavily suggested to upgrade to both a server (that is, [[aMule]]) and [[client]] supporting it. Information about [[ECv2|External Connections v2]] can be reached [[ECv2|here]].
+
* [[aMuleWeb]]  
 +
* [[aMuleCMD]]
 +
* [[aMuleGUI]]
  
'''NOTE:''' You can create the value for the needed ''ECPassword'' like this:
+
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.
  
<code>$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1</code>
+
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 SVN 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_SVN|SVN]] 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).
 
'''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).
  
'''NOTE for [[aMule_CVS|CVS]] users:''' It is very important to use a server (i.e. [[aMule]] or aMuled) and a client ([[aMuleWeb]], [[aMuleCMD]]) from the '''same''' [[aMule_CVS|CVS tarball]]. As development goes on, there are binary incompatibilities between versions, and - in the case of [[aMule_CVS|CVS versions]] - they might cause crashes, burn your house, feed your dog, donate all your hardware to [[aMule]] [[aMule_devs|developers]], etc. Before you'd fall into total despair, extreme care is taken by developers that this cannot happen between '''releases'''! If you're using a server and a client from different releases (not [[aMule_CVS|CVS tarballs]], relases!), most likely you will only get a message "Invalid protocol version." And that's all.
+
For more information on the EC protocol, see [[ECv2|External Connections v2]].

Latest revision as of 11:57, 3 August 2008

English | Deutsch

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

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 SVN 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 SVN 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 Online Signature (outgoing direction) and ED2KLinks file (ingoing direction).

For more information on the EC protocol, see External Connections v2.