docker-amule-dlp

aMule is an eMule-like client for the eDonkey and Kademlia networks. This project maintains docker containers for the aMule fork amule-dlp, which supports dynamic leech protection (DLP). Only aMule daemon and web server are enabled and GUI is disabled in the container. To control aMule, use aMule GUI for remote connection or use your web browswer to visit the web server.

Inspired by the work of tetreum, tchabaud and ngosang.

Supported architectures:

• linux/amd64
• linux/arm/v6
• linux/arm/v7
• linux/arm64
• linux/ppc64le
• linux/s390x
• linux/riscv64

Usage

Docker-compose

The recommended way is to use docker-compose. Create and edit the file docker-compose.yml as the template

version: '2.1'
services:
  amule:
    container_name: amule
    image: minnyres/amule-dlp:latest
    restart: unless-stopped
    network_mode: host
    environment:
      - UID=1000
      - GID=1000
      - WEBUI=bootstrap
      - ECPASSWD=amule-passwd
      - TIMEZONE=Asia/Shanghai
      - RECURSIVE_SHARE=yes
    volumes:
      - <config>:/config
      - <downloads>:/downloads
      - <temp>:/temp

Then, start the container with the command

docker-compose up -d

Volume mapping

In the volumes section, some parameters need to be replaced by the paths on the host system:

• <config> - the directory for configuration files
• <downloads> - the directory for downloaded and shared files
• <temp> - the directory for incomplete download files

Environment variables

Please carefully read the notes on the variables:

Variable	Meaning	Notes
UID	User id	Given by echo $UID on the host system
GID	Usergroup id	Given by echo $GID on the host system
WEBUI	Web UI theme	Can be default, bootstrap or reloaded
ECPASSWD	Password for external connection	This is the password for aMule GUI but not web server. Once the container starts, the password will be persistently saved, and thus the line - ECPASSWD=xxx can be removed hereafter for security.
TIMEZONE	Time zone
RECURSIVE_SHARE	Whether to recursively share the files in the sub-folders of the path <downloads>	Can be yes or no

Bridge network

The above docker-compose configuration uses host network, which is necessary if UPnP is enabled. To use bridge network, use the following template:

version: '2.1'
services:
  amule:
    container_name: amule
    image: minnyres/amule-dlp:latest
    restart: unless-stopped
    network_mode: bridge
    ports:
      - "4711:4711"
      - "4712:4712"
      - "24662:24662"
      - "24665:24665/udp"
      - "24672:24672/udp"
    environment:
      - UID=1000
      - GID=1000
      - WEBUI=bootstrap
      - ECPASSWD=amule-passwd
      - TIMEZONE=Asia/Shanghai
      - RECURSIVE_SHARE=yes
    volumes:
      - <config>:/config
      - <downloads>:/downloads
      - <temp>:/temp

Under bridge network, one needs to enable port mapping for the following ports:

• 4711 - port for aMule web server
• 4712 - port for remote connection with aMule GUI
• 24662 - standard client TCP port
• 24672 - extended client UDP port
• 24665 - extended server request UDP port

The extended server request UDP port must be standard client TCP port + 3, while the other ports can be modified in aMule setting.

Use official aMule

This project also provides an image for official aMule. To run the latest official release v2.3.3 without DLP, just change the image option

 image: minnyres/amule-dlp:official-2.3.3

aMule setting

The settings of aMule are stored in the file <config>/amule.conf. If the file already exists, aMule will use the existing configuration file. Otherwise, aMule will create a new configuration file according to the default settings. Some of the default settings are listed below:

• port for aMule web server: 4711
• port for remote connection with aMule GUI: 4712
• standard client TCP port: 24662
• extended client UDP port: 24672
• extended server request UDP port: 24665
• password for external connection: amule-passwd
• web server password: amuleweb-passwd
• web UI theme: bootstrap
• UPnP: enabled

To view and change the settings, one can connect to aMule with aMule GUI. Note that aMule GUI does not support to change the web UI theme and password for external connection, and it is recommended to set the two options by docker-compose.