|
| 1 | +[hub]:https://hub.docker.com/r/logicwar/mldonkey/ |
| 2 | +[MLDonkey_wikipedia]:https://en.wikipedia.org/wiki/MLDonkey |
| 3 | +[tz_wikipedia]:https://en.wikipedia.org/wiki/List_of_tz_database_time_zones |
| 4 | + |
| 5 | +# [Docker Container for MLDonkey][hub] |
| 6 | + |
| 7 | +This is a Docker image based on osixia/light-baseimage for running MLDonkey 3.1.5. |
| 8 | + |
| 9 | +MLDonkey is an open source, multi-protocol, peer-to-peer file sharing application that runs as a back-end server application on many platforms. It can be controlled through a user interface provided by one of many separate front-ends, including a Web interface, telnet interface and over a dozen native client programs. [Wikipedia][MLDonkey_wikipedia] |
| 10 | + |
| 11 | +MLDonkey is free software, released under the terms of the GNU General Public License. |
| 12 | + |
| 13 | +## Usage |
| 14 | + |
| 15 | +``` |
| 16 | +docker create --name=mldonkey \ |
| 17 | + -v <path for config files>:/var/lib/mldonkey:rw \ |
| 18 | + -v <path for temporary files>:/mnt/mldonkey_tmp:rw \ |
| 19 | + -v <path for completed downloaded files>:/mnt/mldonkey_completed:rw \ |
| 20 | + -e PGID=<gid> |
| 21 | + -e PUID=<uid> \ |
| 22 | + -e TZ=<timezone> \ |
| 23 | + -p 4000:4000 \ |
| 24 | + -p 4001:4001 \ |
| 25 | + -p 4080:4080 \ |
| 26 | + -p 20562:20562 \ |
| 27 | + -p 20566:20566/udp \ |
| 28 | + -p 16965:16965 \ |
| 29 | + -p 16965:16965/udp \ |
| 30 | + -p 6209:6209 \ |
| 31 | + -p 6209:6209/udp \ |
| 32 | + -p 6881:6881 \ |
| 33 | + -p 6882:6882 \ |
| 34 | + -p 3617:3617/udp \ |
| 35 | + -p 4444:4444 \ |
| 36 | + -p 4444:4444/udp \ |
| 37 | + logicwar/mldonkey |
| 38 | +``` |
| 39 | + |
| 40 | +## Parameters |
| 41 | +* `-p 4000` - Telnet port |
| 42 | +* `-p 4001` - GUI port |
| 43 | +* `-p 4080` - HTTP port for the Web interface |
| 44 | +* `-p 20562` - eDonkey2000 port |
| 45 | +* `-p 20566/udp` - eDonkey2000 port |
| 46 | +* `-p 16965` - Kad port (disabled by default) |
| 47 | +* `-p 16965/udp` - Kad1 port (disabled by default) |
| 48 | +* `-p 6209` - Overnet port (disabled by default) |
| 49 | +* `-p 6209/udp` - Overnet port (disabled by default) |
| 50 | +* `-p 6881` - BitTorrent Client port (disabled by default) |
| 51 | +* `-p 6882`- BitTorrent Tracker port (disabled by default) |
| 52 | +* `-p 3617/udp` - BitTorrent DHT port (disabled by default) |
| 53 | +* `-p 4444` - BitTorrent DHT port (disabled by default) |
| 54 | +* `-p 4444/udp` - BitTorrent DHT port (disabled by default) |
| 55 | +* `-v /var/lib/mldonkey` - where LMS stores config and log files |
| 56 | +* `-v /mnt/mldonkey_tmp` - local path for your audios |
| 57 | +* `-v /mnt/mldonkey_completed` - local path for your playlists |
| 58 | +* `-e PGID` for GroupID - see below for explanation |
| 59 | +* `-e PUID` for UserID - see below for explanation |
| 60 | +* `-e TZ` for timezone information : Europe/London, Europe/Zurich, America/New_York, ... ([List of TZ][tz_wikipedia]) |
| 61 | + |
| 62 | +For shell access while the container is running do `docker exec -it mldonkey /bin/bash` |
| 63 | + |
| 64 | +### User / Group ID |
| 65 | + |
| 66 | +For security reasons and to avoid permissions issues with data volumes (`-v` flags), you may want to create a specific "docker" user with proper right accesses on your persistant folders. To find your user **uid** and **gid** you can use the `id <user>` command as below: |
| 67 | + |
| 68 | +``` |
| 69 | + $ id <dockeruser> |
| 70 | + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) |
| 71 | +``` |
| 72 | + |
| 73 | +and finally specify your "docker" user `PUID` and group `PGID`. In this exemple `PUID=1001` and `PGID=1001`. |
| 74 | + |
| 75 | +## Setting up the application |
| 76 | + |
| 77 | +The intitial setup is made by browsing to http://your_server_IP:4080 and begin configuring the MDDonkey Server. |
| 78 | + |
| 79 | +The first thing to do is to **set a password for the admin user**. you can use the command in the input field: `useradd admin <your_password>` |
| 80 | + |
| 81 | +By default only eDonkey is enabled. To enable the other networks go to `Options->Net` and set to `true` what you need. |
| 82 | + |
| 83 | +## Container default configuation |
| 84 | +|Network|Type|MLDonkey default|Default Container Setup|Configuration file| |
| 85 | +|---|---|---|---|---| |
| 86 | +|http_port|TCP|4080|4080|downloads.ini| |
| 87 | +|telnet_port|TCP|4000|4000|downloads.ini| |
| 88 | +|gui_port|TCP|4001|4001|downloads.ini| |
| 89 | +|eDonkey2000|TCP|random|20562|donkey.ini| |
| 90 | +|eDonkey2000|UDP|TCP port + 4|20566|donkey.ini| |
| 91 | +|Kad|TCP|random|16965|donkey.ini, Kademlia section| |
| 92 | +|Kad1|UDP|Same as TCP|16965|donkey.ini, Kademlia section| |
| 93 | +|Overnet|TCP|random|6209|donkey.ini, Overnet section| |
| 94 | +|Overnet|UDP|Same as TCP|6209|donkey.ini, Overnet section| |
| 95 | +|BitTorrent Client |TCP|6882|6882|bittorrent.ini| |
| 96 | +|BitTorrent Tracker |TCP|6881|6881|bittorrent.ini| |
| 97 | +|BitTorrent DHT |UDP|random|3617|bittorrent.ini| |
| 98 | +|DirectConnect|TCP|4444|4444|directconnect.ini| |
| 99 | +|DirectConnect|UDP|Same as TCP|4444|directconnect.ini| |
| 100 | + |
| 101 | + |
| 102 | + |
| 103 | +## Versions |
| 104 | ++ **V0.1** Initial Release 3.1.5 |
0 commit comments