AMule Project FAQ - User contributions [en]

AMuleWeb

2008-06-14T14:04:03Z

84.223.94.197:

<center>'''English''' | [[AMuleWeb-de|Deutsch]] | [[AMuleWeb-it|Italiano]] </center>

'''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 if 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. If you're a debian or ubuntu user and you use Synaptic, be shure to install not only amule and amule-common package, but also amule-daemon package.

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 options 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 file|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

(In fact, if you've installed aMule by package, installing also the amule-common and amule-daemon package, you shouldn't need to give this terminal commands; everything should work simply by correctly setting the "Remote Controls" page and restarting aMule)

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 <nowiki>[</nowiki>ExternalConnect<nowiki>]</nowiki> section of amule.conf:

*''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 --> <nowiki>[</nowiki>4712<nowiki>]</nowiki> --> aMuleWeb --> <nowiki>[</nowiki>4711<nowiki>]</nowiki> --> 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 &"
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

== Template language and development ==

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

== Version ==
Created by "Unknown User" on 21.07.04 at 20:55 
Updated by Vollstrecker on 18.01.08 at 13:18

AMuleWeb-it

2008-06-14T14:03:03Z

84.223.94.197:

<center>'''Italiano''' | [[AMuleWeb|English]] | [[AMuleWeb-de|Deutsch]]</center>

'''aMuleWeb''' è un'utility che vi permette di controllare aMule tramite un browser web da qualsiasi luogo. L'interfaccia web offre una ristretta cerchia delle funzionalità di aMule, tra cui la ricerca di file, l'aggiunta di nuovi download, e la visualizzazione della vostra coda di download. Mostra inoltre le informazioni di stato e vi permette di modificare alcune opzioni.

aMule di per sè non supporta connessioni [http://www.w3.org/MarkUp HTTP]; aMuleWeb, che le supporta, funziona quindi da intermediario tra aMule e un browser web. Una volta che la connessione tra aMuleWeb e l'utente remoto è stata stabilita, aMuleWeb si connette ad aMule attraverso l'interfaccia [[External Connections|Connessioni Esterne]].

Di base, aMuleWeb attende le conenssioni HTTP sulla porta 4711, ma questo può essere cambiato in [[Usage Preferences|Preferenze]].

== Installare aMuleWeb ==

Molte, se non tutte le distro hanno un pacchetto aMule nei propri repository. Se installate aMule con un pacchetto RPM, DEB, o attraverso altri sistemi di gestione dei pacchetti, aMuleWeb sarà incluso nell'installazione. Se siete un utente debian o ubuntu e usate Synaptic, accertatevi di installare non solo i pacchetti amule e amule-common, ma anche il pacchetto amule-daemon.

Questo è il più semplice e preferibile metodo di installare aMule e aMuleWeb.

== Compilare aMuleWeb ==

Se non avete installato aMule usando un pacchetto, necessiterete di compilarlo dal codice sorgente.

aMuleWeb non è compilato separatamente; è compilato contemporaneamente ad aMule usando il flag ''--enable-amuleweb'' quando eseguite ''configure''. (Vedere la [[Main_Page-it|Pagina principale]] per i link a pagine riguardo alla compilazione di aMule per vari sistemi operativi).

== Configurare aMuleWeb ==

Per usare aMuleWeb, avrete prima bisogno di impostare alcune opzioni nella sezione Preferenze di aMule. Nella pagina "Controlli Remoti" dovrete:

* Abilitare "Accetta Connessioni Esterne".
* Inserire una password per le Connessioni Esterne.
* Abilitare webserver all'avvio.

Potete anche modificare la porta predefinita di aMuleWeb (4711) e la porta delle Connessioni Esterne (4712) in questa pagina, ma facendolo, dovrete riavviare aMule per rendere effettive le modifiche.

(Se state usando aMuled e non volete usare aMule per configurare aMuleWeb, guardare le istruzioni sotto)

Quindi, ciò di cui avete bisogno è generare [[remote.conf file|remote.conf]], il file dove aMuleWeb salva le proprie informazioni di configurazione. (Potete trovarlo nella directory .aMule.)
Tra le altre cose, questo file contiene il numero di porta che aMule usa per le Connessioni Esterne e le password necessarie per accedere ad aMule.

Per creare un file ''remote.conf'', immettere da terminale il comando:

$ amuleweb -w

aMuleWeb leggerà le informazioni di configurazione necessareie da amule.conf e cenererà un file ''remote.conf'' , quindi uscirà.

Ora lanciate aMuleWeb normalmente:

$ amuleweb

(In realtà se avete installato aMule come pacchetto seguendo le suddette istruzioni, questi due comandi non sono necessari, basterà effettuare le impostazioni corrette in "Controlli Remoti" e riavviare aMule affinchè tutto funzioni)

Ora dovreste essere in gradi di aprire aMuleWeb in un browser digitando l'URL (sulla macchina su cui gira aMule):

http://localhost:4711

oppure, con il nome di dominio del computer (in locale o da remoto):

http://hostname:4711

Se volete far girare aMuleWeb su una macchina diversa da quella di aMule, semplicemente copiate ''remote.conf'' nella directory .aMule di quel computer, e cambiate correttamente il valore che segue a "Host=".

'''NOTA:''' aMuleWeb usa i cookies per salvare le informazioni della sessione. Assicuratevi che i cookies siano abilitati nel vostro browser.

== Lanciare aMuleWeb ==

Ci sono due modi per lanciare aMuleWeb.

Il primo, e preferibile, è di abilitare l'attivazione di aMuleWeb nelle preferenze di aMule. Quando viene lanciato, aMule (o aMuled) lancerà aMuleWeb. A seguito dell'uscita, aMuleWeb sarà automaticamente terminato.

La seconda opzione è di lanciare aMuleWeb manualmente, digitando il comando "amuleweb" nel terminale.

== Configurare aMuleWeb con aMuled ==

Innanzitutto, se aMuled sta girando, chiudetelo.

Quindi digitate:

$ amuleweb -w

per generare un file ''remote.conf''. Avrete bisogno di modificare queste opzioni nella sezione <nowiki>[</nowiki>ExternalConnect<nowiki>]</nowiki> di amule.conf:

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

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

Potete ora riavviare aMuled e aMuleWeb.

'''NOTA:''' Le password devono essere nel formato md5sum. Per generare un MD5sum per la vosta password, da terminale:
''$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1''
''ca3c365274907c6fd527068788e14639''

'''Nota'''Se ottenete la risposta ''FATAL ERROR: Cannot find template: default'' è perchè non avete lanciato ''make install''. Se non volete installare aMule, copiate la directory ''src/webserver/default/'' in ''~/.aMule/webserver/'' (createla se necessario).
Se volete un qualsiasi altro template (probabilmente ''php-default''), copiate anche quello. Quindi tornate al passo precedente.

=== aMuleWeb con versioni precedenti di aMule ===

Per istruzioni su come usare aMuleWeb con aMule pre-2.0.0 final, vedere [[Webserver-old|this page]] per il materiale archiviato.

== Porte standard ==

The ports can be set to anything, but by default aMule uses:
Le porte possono essere settate a qualunque valore, ma come predefinite aMule usa:

*Connecssioni Esterne: 4712
*amuleweb: 4711

Assicuratevi di non confondere le due; nella configurazione predefinita, dovrebbe essere così:

aMule --> <nowiki>[</nowiki>4712<nowiki>]</nowiki> --> aMuleWeb --> <nowiki>[</nowiki>4711<nowiki>]</nowiki> --> web browser

== Percorsi dei Template (skin) ==

aMuleWeb cerca i propri files in diversi posti:

*Nella vostra home directory: ''$HOME/.aMule/webserver/''<nowiki>[</nowiki>skin name<nowiki>]</nowiki>''/''

*E nella sua directory di instalalzione, in questo ordine (di default, ''/usr/local/share/amule/webserver'' se avete compilato aMule, o ''/usr/share/amule/webserver'' se l'avete installato tramite pacchetto).

Il nome del template di Default è 'default'.

Se, ''dopo aver installato'' aMule, aMuleWeb si rifiuta di funzionare o non è in grado di caricare un template:

*Per favore, segnalaci la situazione e poi

*Create le directories ''webserver/default'' nella sottodirectory ''.aMule'' della vostra home, e copiate qui il contenuto della cartella ''src/webserver'' dall'archivio tarball di aMule (es, ''$HOME/.aMule/webserver/default'').

== aMuled e aMuleWeb come servizi ==

Benchè lanciare aMuleWeb abilitandolo nelle preferenze di aMule sia il metodo da preferire, potete anche lanciare aMuleWeb insieme ad aMuled come servizi, attraverso uno script init.d . Questo è un esempio:

''/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 &"
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

Quindi semplicemente impostate che quello script venga eseguito all'accensione. Su [[Debian]] questo potrebbe essere fatto con il comando seguente:

update-rc.d amule defaults

Quindi, per far partire i demoni dovete creare un file ''etc/default/amule'' che contenga una sola linea:

RUNAMULE=yes

== Sviluppo e lingua dei Template ==

I template di aMuleWeb sono normali file HTML. Per renderli "interattivi", il linguaggio lato server è implementato internamente. Questo linguaggio è un dialetto ridotto del PHP. Informazioni maggiormente dettagliate possono essere trovate a [[aMuleWeb_PHP]].

== Dove riportare problemi e domande? ==

Per Problemi o Domande semplicemente scrivete sul forum http://forum.amule.org o entrate nel canale [[IRC]] [irc://irc.freenode.net/amule #amule] su [irc://irc.freenode.net irc.freenode.net]

== Altre fonti di informazione ==

Read the aMuleWeb man page, which is available in English, French, German, Hungarian and Spanish.
Leggete la pagina di manuale di aMuleWeb, che è disponibile in Inglese, Francese, Tedesco, Ungherese e Spagnolo.

Per ulteriori informazioni leggete la [[FAQ_webserver|FAQ di aMuleWeb]].

== Version ==
Created by "Unknown User" on 21.07.04 at 20:55 
Updated by Vollstrecker on 18.01.08 at 13:18 
Tradotto da--[[User:84.223.94.197|84.223.94.197]] 16:03, 14 June 2008 (CEST)

AMuleWeb

2008-06-14T13:36:59Z

84.223.94.197: /* Configuring aMuleWeb */

<center>'''English''' | [[AMuleWeb-de|Deutsch]]</center>

'''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 if 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. If you're a debian or ubuntu user and you use Synaptic, be shure to install not only amule and amule-common package, but also amule-daemon package.

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 options 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 file|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

(In fact, if you've installed aMule by package, installing also the amule-common and amule-daemon package, you shouldn't need to give this terminal commands; everything should work simply by correctly setting the "Remote Controls" page and restarting aMule)

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 <nowiki>[</nowiki>ExternalConnect<nowiki>]</nowiki> section of amule.conf:

*''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 --> <nowiki>[</nowiki>4712<nowiki>]</nowiki> --> aMuleWeb --> <nowiki>[</nowiki>4711<nowiki>]</nowiki> --> 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 &"
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

== Template language and development ==

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

== Version ==
Created by "Unknown User" on 21.07.04 at 20:55 
Updated by Vollstrecker on 18.01.08 at 13:18

AMuleWeb

2008-06-14T11:40:34Z

84.223.94.197: /* Installing aMuleWeb */

<center>'''English''' | [[AMuleWeb-de|Deutsch]]</center>

'''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 if 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. If you're a debian or ubuntu user and you use Synaptic, be shure to install not only amule and amule-common package, but also amule-daemon package.

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 options 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 file|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 <nowiki>[</nowiki>ExternalConnect<nowiki>]</nowiki> section of amule.conf:

*''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 --> <nowiki>[</nowiki>4712<nowiki>]</nowiki> --> aMuleWeb --> <nowiki>[</nowiki>4711<nowiki>]</nowiki> --> 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 &"
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

== Template language and development ==

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

== Version ==
Created by "Unknown User" on 21.07.04 at 20:55 
Updated by Vollstrecker on 18.01.08 at 13:18