Difference between revisions of "AMuleWeb"

From AMule Project FAQ
Jump to: navigation, search
(aMuled and aMuleWeb as services)
 
(23 intermediate revisions by 18 users not shown)
Line 1: Line 1:
== Description ==
+
<center>'''English''' | [[AMuleWeb-de|Deutsch]] | [[AMuleWeb-it|Italiano]] </center>
  
aMuleWeb is a utility that listens for [http://www.w3.org/MarkUp HTTP] connections at port 4711 (by default, although it can be changed through '''Preferences''') and allows remote users to control [[aMule]] using just a web browser.  
+
'''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 listening to [http://www.w3.org/MarkUp HTTP] connections, so the external utility aMuleWeb is used. This utility listens for remote connections, and once the link between aMuleWeb and the remote user is established, it connects to the [[aMule]] main program using the [[External Connections]] mechanism.
+
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.
  
== Compiling aMuleWeb ==
+
By default, aMuleWeb listens for HTTP connections at port 4711, but this can be changed in [[Usage Preferences|Preferences]]'.
  
[[Compile]] [[aMule]] normally, just add ''--enable-amuleweb'' when running ''configure''.
+
== Set a password ==
  
== Setting up aMuleWeb with [[aMule]] ==
+
To connect to the web server a password must be set, otherwise connection is refused. To set a password run aMuleWeb with --admin-pass=your_password.
  
=== aMuleWeb with [[aMule]] 2.0.0 or later ===
+
== Standard ports ==
  
*For users running the monotlithic [[aMule]] application:
+
The ports can be set to anything, but by default aMule uses:
**Go to "Preferences"->"Remote Controls" (in [[aMule]]) and...
+
***Enable "Accept External Connections".
+
***Enable "Use TCP ports instead of unix local sockets" (This option doesn't exist since version 2.1.0)
+
***Enter a password for [[External Connections]]. If you don't do this, aMuleWeb will not communicate with [[aMule]].
+
::'''NOTE:''' When you change your aMuleWeb and [[External Connections]] ports here, make sure to restart [[aMule]].
+
  
*For users running the [[aMule|aMule daemon]]:
+
*External Connections: 4712
**Shutdown [[aMule|aMuled]] if it is still running.
+
*amuleweb: 4711
**Run ''amuleweb -w'' to generate ''~/.aMule/remote.conf'' and edit it for these options. It previously were on ''~/.aMule/amule.conf'', but the lines are still on this file, so edit both if in doubt.
+
***''[ExternalConnect]'' <- Section header
+
***''AcceptExternalConnections=1'' <-- To enable [[aMule]] listening for [[External Connections]].
+
***''ECUseTCPPort=1'' <-- To use the [http://www.faqs.org/faqs/internet/tcp-ip/resource-list TCP] port. Very important since [http://www.unix.org Unix] sockets are disabled.
+
***''ECPassword=ca3c365274907c6fd527068788e14639'' <-- To find the MD5 string for your password, do:
+
:::''$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1''
+
:::''ca3c365274907c6fd527068788e14639''
+
**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.
+
**Restart [[aMule|aMuled]]
+
  
'''NOTE:''' In [[aMule]] version 2.0.0 and later you don't need to do any copy/link of [[aMuleWeb|webserver]] files.
+
Make sure you do not confuse the two; in the default configuration, it looks like this:
  
'''NOTE2:''' Every password must be md5sum,also webserver one/s. aMule embedded webserver works without remote.conf,you just need to edit ''amule.conf''. A good trick if you have somewhere an X server is to configure amule using the GUI and then copy the ''amule.conf'' configuration file where you want to run the daemon.
+
aMule --&gt; <nowiki>[</nowiki>4712<nowiki>]</nowiki> --&gt; aMuleWeb --&gt; <nowiki>[</nowiki>4711<nowiki>]</nowiki> --&gt; web browser
  
Thanks to [[User:Stefanero|Stefanero]], from who I shamelessly stole a lot from his tutorial.
+
== Template (skin) location ==
  
'''NOTE3:''' aMuleWeb uses cookies to hold session id. Make sure that cookies are enabled in your browser.
+
aMuleWeb looks for its files in a number of places:
  
=== aMuleWeb with [[aMule]] pre-2.0.0 final ===
+
*In your home directory: ''$HOME/.aMule/webserver/''<nowiki>[</nowiki>skin name<nowiki>]</nowiki>''/''
  
Please check [[Webserver-old|this page]] for archived instructions (educational purposes!).
+
*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).
  
== Connecting to aMuleWeb ==
+
Default template name is 'default'.
  
To run aMuleWeb run '''''amuleweb''''' on a terminal.
+
If, ''after installing'' aMule, aMuleWeb refuses to run because of not being able to load template:
  
Once aMuleWeb is running, open a web browser and connect to:
+
*Please report this situation to us, and then
  
''http://host:port''
+
*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'').
  
where ''host'' stands for your host's name (try with ''localhost'') and port stands for the aMuleWeb port ('''NOT''' the [[External Connections]] port).
+
== aMuled and aMuleWeb as services  ==
  
For example: ''http://localhost:4711''
+
Although starting aMuleWeb by enabling it in aMule'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:
  
''Shakraw''
+
''/etc/init.d/amule''
 
+
== Standard ports ==
+
 
+
The ports can be set to anything, but this are the most used (the standard ones):
+
 
+
*[[External Connections]]: 4712
+
*amuleweb: 4711
+
 
+
Make sure you do not confuse with what each of them is.
+
 
+
== Skin support ==
+
 
+
aMuleWeb now looks for its files in a number of places:
+
*In your home directory: ''$HOME/.aMule/webserver/''[skin name]''/''
+
*And at it's 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 skin (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 (I mean to ''$HOME/.aMule/webserver/default'').
+
 
+
'''[[User:GonoszTopi|GonoszTopi]]'''
+
 
+
== How to start [[aMule Daemon|aMuled]] and aMuleWeb with your computer ==
+
 
+
The best way to start both the processes aMule Daemon and aMuleWeb with your server is to add a shell script ''/etc/init.d/amule'' like this:
+
  
 
  PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
 
  PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
Line 91: Line 50:
 
  DESC=amuled
 
  DESC=amuled
 
  RUNAMULE=no
 
  RUNAMULE=no
 +
USER=youramuleuser
 
   
 
   
 
  test -x $DAEMON || exit 0
 
  test -x $DAEMON || exit 0
 
   
 
   
 
  # Include amule defaults if available
 
  # Include amule defaults if available
  if [ -f /etc/default/amule ] ; then
+
  if <nowiki>[</nowiki> -f /etc/default/amule <nowiki>]</nowiki> ; then
 
     . /etc/default/amule
 
     . /etc/default/amule
 
  fi
 
  fi
 
+
  if [ "$RUNAMULE" != "yes" ];then
+
  if <nowiki>[</nowiki> "$RUNAMULE" != "yes" <nowiki>]</nowiki> ; then
 
     echo "Amule not to be started. Edit /etc/default/amule first."
 
     echo "Amule not to be started. Edit /etc/default/amule first."
 
     exit 1
 
     exit 1
Line 109: Line 69:
 
   start)
 
   start)
 
     echo -n "Starting $DESC: "
 
     echo -n "Starting $DESC: "
         su youramuleuser -c "$DAEMON -f"
+
         su $USER -c "$DAEMON -f"
         su youramuleuser -c "$WEB --quiet &"
+
        while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
 +
         su $USER -c "$WEB --quiet &amp;"
 
     echo "$NAME."
 
     echo "$NAME."
 
     ;;
 
     ;;
Line 124: Line 85:
 
         killall --quiet --ignore-case $DAEMON
 
         killall --quiet --ignore-case $DAEMON
 
     sleep 1
 
     sleep 1
         su youramuleuser -c "$DAEMON -f"
+
         su $USER -c "$DAEMON -f"
         su youramuleuser -c "$WEB --quiet &"
+
        while ! netstat -l -n -p -t | grep -q amuled ; do sleep 1 ; done
 +
         su $USER -c "$WEB --quiet &amp;"
 
     echo "$NAME."
 
     echo "$NAME."
 
     ;;
 
     ;;
 
   *)
 
   *)
 
     N=/etc/init.d/$NAME
 
     N=/etc/init.d/$NAME
     echo "Usage: $N {start|stop|restart|force-reload}" >&2
+
     echo "Usage: $N {start|stop|restart|force-reload}" &gt;&2
 
     exit 1
 
     exit 1
 
     ;;
 
     ;;
Line 137: Line 99:
 
  exit 0
 
  exit 0
  
Then just set that script to be run at start up. On [[Debian]] this would be doen with the following command:
 
  
ln -s /etc/init.d/amule /etc/rc2.d/S61amule
 
  
Then, for the deamons to start you just have to create a file ''/etc/default/amule'' which contains a single line:
+
Then just set that script to be run at start up. On [[Debian]] this would be done 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
 
  RUNAMULE=yes
  
That's it!
+
 
 +
=== Ubuntu ===
 +
 
 +
Ubuntu has a script in /etc/init.d already called amule-daemon
 +
 
 +
You need to set the user by editing /etc/default/amule-daemon, and amuled will be started as that user.
  
 
== Where to report problems and questions? ==
 
== Where to report problems and questions? ==

Latest revision as of 00:49, 1 August 2009

English | Deutsch | Italiano

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 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 Preferences'.

Set a password

To connect to the web server a password must be set, otherwise connection is refused. To set a password run aMuleWeb with --admin-pass=your_password.

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 in aMule'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 done 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


Ubuntu

Ubuntu has a script in /etc/init.d already called amule-daemon

You need to set the user by editing /etc/default/amule-daemon, and amuled will be started as that user.

Where to report problems and questions?

For Problems or Questions just report on http://forum.amule.org forum or join IRC channel #amule at 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 aMuleWeb FAQ.