Difference between revisions of "Webserver"

From AMule Project FAQ
Jump to: navigation, search
(=Webserver with aMule 2.0.0-rc1 or later=)
Line 37: Line 37:
  
 
'''[[User:Stefanero|Stefanero]]'''
 
'''[[User:Stefanero|Stefanero]]'''
 +
 +
=== Webserver with [[aMule]] 2.0.0 or later (starting from CVS 2005.02.27) ===
 +
 +
*For users running the monotlithic [[aMule]] application:
 +
**Go to "Preferences"->"Remote Controls" (in [[aMule]]) and...
 +
***Enable "Accept External Connections".
 +
***Enable "Use TCP ports instead of unix local sockets".
 +
***Enter a password for external connections. If you don't do this, amuleweb will not communicate with amule.
 +
::'''NOTE:''' When you change your [[aMuleWeb|webserver]] and [[External Connections]] ports here, make sure to restart [[aMule]].
 +
 +
*For users running the [[aMule|aMule daemon]]:
 +
**Shutdown [[aMule|aMuled]] if it is still running.
 +
**Edit your ''~/.eMule'' file, locate the ''[ExternalConnect]'' section and change:
 +
***''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''
 +
*Restart [[aMule|aMuled]]
 +
 +
'''NOTE:''' In [[aMule]] version 2.0.0 and later you don't need to do any copy/link of webserver files.
 +
 +
==== Skin support ====
 +
 +
[[aMuleWeb|Webserver]] now looks for its files in a number of places:
 +
*''$HOME/.aMule/webserver/''[skin name]''/''
 +
*And default install locations, such as:
 +
**''/usr/share/amule/webserver/''[skin name]''/''
 +
**''/usr/local/share/amule/webserver/''[skin name]''/''
 +
 +
Default skin (template) name is 'default'.
 +
 +
If, '''after installing''' [[aMule]], [[aMuleWeb|webserver]] refuses to run because of not being able to load template, you can run ''amuleweb -d'' to see where it tries to find the template. If you didn't use ''--prefix='' when configuring [[aMule]], please report this situation on our [http://forum.amule.org forum], indicating your OS and the place where ''make install'' put your ''webserver/'' directory.
 +
 +
Thanks to [[User:Stefanero|Stefanero]], from who I shamelessly stole a lot from his tutorial.
 +
 +
'''[[User:GonoszTopi|GonoszTopi]]'''
  
 
== Connecting to [[aMuleWeb|amuleweb]] ==
 
== Connecting to [[aMuleWeb|amuleweb]] ==

Revision as of 15:19, 27 February 2005

Setting up Webserver with aMule

Webserver with aMule 1.2.8 or earlier

Webserver with aMule 2.0.0-rc1 or later

  • Untar the sources and copy src/aMule.tmpl and src/webserver/ into your ~/.aMule/ directory. The following (run from the sources directory), should do so:
$ cp -r src/aMule.tmpl src/webserver/ ~/.aMule/
  • If you installed aMule from rpm, then you can do:
$ cp /usr/share/amuleweb/aMule.tmpl ~/.aMule/
$ cp -r /usr/share/amuleweb/webserver/ ~/.aMule/
  • Go to "Preferences"->"Remote Controls" (in aMule) and...
    • Enable "Accept External Connections".
    • Enable "Use TCP ports instead of unix local sockets".
    • Enter a password for external connections. If you don't do this, amuleweb will not communicate with amule.
NOTE: On some early aMule 2.0.0-rcX versions the above options weren't available (or didn't work). If you are using such aMule version and you don't wish to upgrade, then do the following:
Shutdown aMule if it is still running.
Edit your ~/.eMule file, locate the [ExternalConnect] section and change:
AcceptExternalConnections=1 <-- To enable aMule listening for External Connections.
ECUseTCPPort=1 <-- To use the TCP port. Very important since Unix sockets are disabled.
ECPassword=ca3c365274907c6fd527068788e14639 <-- To find the MD5 string for your password, do:
$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1
ca3c365274907c6fd527068788e14639
NOTE: When you change your webserver and External Connections ports here, make sure to restart aMule.
NOTE: that "Enable Webserver" has no effect and will be renamed in 2.0.0rc8. Webserver is always enabled as long as you have External Connections enabled.
NOTE: For users running aMule Daemon you have to edit the .eMule file like shown above. For a way to setup a password check the 1.2.8 aMule HowTo. You can still do it in the same way.
  • Now you're done! You are ready to run amuleweb and connect to it.

Stefanero

Webserver with aMule 2.0.0 or later (starting from CVS 2005.02.27)

  • For users running the monotlithic aMule application:
    • Go to "Preferences"->"Remote Controls" (in aMule) and...
      • Enable "Accept External Connections".
      • Enable "Use TCP ports instead of unix local sockets".
      • Enter a password for external connections. If you don't do this, amuleweb will not communicate with amule.
NOTE: When you change your webserver and External Connections ports here, make sure to restart aMule.
  • For users running the aMule daemon:
    • Shutdown aMuled if it is still running.
    • Edit your ~/.eMule file, locate the [ExternalConnect] section and change:
      • AcceptExternalConnections=1 <-- To enable aMule listening for External Connections.
      • ECUseTCPPort=1 <-- To use the TCP port. Very important since Unix sockets are disabled.
      • ECPassword=ca3c365274907c6fd527068788e14639 <-- To find the MD5 string for your password, do:
$ echo -n yourpasswordhere | md5sum | cut -d ' ' -f 1
ca3c365274907c6fd527068788e14639

NOTE: In aMule version 2.0.0 and later you don't need to do any copy/link of webserver files.

Skin support

Webserver now looks for its files in a number of places:

  • $HOME/.aMule/webserver/[skin name]/
  • And default install locations, such as:
    • /usr/share/amule/webserver/[skin name]/
    • /usr/local/share/amule/webserver/[skin name]/

Default skin (template) name is 'default'.

If, after installing aMule, webserver refuses to run because of not being able to load template, you can run amuleweb -d to see where it tries to find the template. If you didn't use --prefix= when configuring aMule, please report this situation on our forum, indicating your OS and the place where make install put your webserver/ directory.

Thanks to Stefanero, from who I shamelessly stole a lot from his tutorial.

GonoszTopi

Connecting to amuleweb

To run aMuleWeb run amuleweb on a terminal. For more information about running aMuleWeb check the aMuleWeb document.

Once aMuleWeb is running, open a web browser and connect to:

http://host:port

where host stands for your host's name (try with localhost) and port stands for the aMuleWeb port (NOT the External Connections port).

For example: http://localhost:4711

Standard ports

The ports can be set to anything, but this are the most used (the standard ones):

Make sure you do not confuse with what each of them is.

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

Retrieved from "http://wiki.amule.org/t/index.php?title=Webserver&oldid=2358"