Difference between revisions of "AMuleWeb"

From AMule Project FAQ
Jump to: navigation, search
(aMuled and aMuleWeb as services)
 
(39 intermediate revisions by 25 users not shown)
Line 1: Line 1:
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.
+
<center>'''English''' | [[AMuleWeb-de|Deutsch]] | [[AMuleWeb-it|Italiano]] </center>
  
[[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.
+
'''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]]'.
 +
 
 +
== 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 --&gt; <nowiki>[</nowiki>4712<nowiki>]</nowiki> --&gt; aMuleWeb --&gt; <nowiki>[</nowiki>4711<nowiki>]</nowiki> --&gt; web browser
 +
 
 +
== Template (skin) location ==
 +
 
 +
aMuleWeb looks for its files in a number of places:
 +
 
 +
*In your home directory: ''$HOME/.aMule/webserver/''<nowiki>[</nowiki>skin name<nowiki>]</nowiki>''/''
 +
 
 +
*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 <nowiki>[</nowiki> -f /etc/default/amule <nowiki>]</nowiki> ; then
 +
    . /etc/default/amule
 +
fi
 +
 +
if <nowiki>[</nowiki> "$RUNAMULE" != "yes" <nowiki>]</nowiki> ; 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 &amp;"
 +
    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 &amp;"
 +
    echo "$NAME."
 +
    ;;
 +
  *)
 +
    N=/etc/init.d/$NAME
 +
    echo "Usage: $N {start|stop|restart|force-reload}" &gt;&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 [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]].
 
For further information read the [[FAQ_webserver|aMuleWeb FAQ]].

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.