Install on Synology
The njMule package for Synology DSM runs the headless engine with its web interface on the NAS. You use it from a browser, through the web interface. It runs as a user of its own, without administrator rights.
What you need
- DSM 7.0 or later;
- a NAS with an x86_64 processor, those with a Celeron or Atom included. There is no package for ARM models; if your NAS runs Docker, the Docker image has an arm64 version.
Download
| File (njMule 0.3.1) | What it is |
|---|---|
njmule-0.3.1-synology-x86_64.spk | Package for DSM 7 on x86_64 |
Older versions are on the GitHub releases page. You can check the download first.
Install
- In DSM, open Package Center and choose Manual Install.
- Choose the
.spkfile you downloaded. DSM warns that the package is not signed by Synology: confirm to go on. - The wizard asks for the web interface password: choose one of 8 characters at least. It also offers a guest password, another one, for people who may only look; leave it empty for no guest. njMule keeps only a hash of each.
- Finish the wizard. njMule starts.
The package creates the shared folder njmule: completed downloads go there, so you reach them
from File Station or over the network as any other shared folder. The settings, unfinished
downloads and logs stay in the package's own folder, /var/packages/njmule/var.
Open the web interface
Open njMule from Package Center (Open) or from the DSM main menu, or go to
http://<address of the NAS>:4711/ and log in with the password. The first time, a short set-up
opens: see First start.
The interface answers to the addresses of the NAS, to its name (<name> and <name>.local, set at
installation) and to the QuickConnect name of the address under which DSM opens it. Against DNS
rebinding it refuses other names. Its own settings, the host names among them, change here only
with the command line over SSH (--webui-host), never from a browser: see
Web interface security.
Firewall and router
The package lists its ports as njMule services in the DSM firewall:
| Service | Port |
|---|---|
| njMule web interface | 4711/TCP |
| njMule eD2K (TCP) | 4662/TCP |
| njMule eD2K and Kad (UDP) | 4672/UDP |
If the DSM firewall is on, allow them there. These services name the default ports: if you change njMule's ports or the web interface's, allow the new ones in the DSM firewall by hand. For a High ID, so that other clients can reach you, the router must forward 4662/TCP and 4672/UDP (or your own ports) to the NAS, or njMule asks it to through UPnP. See Ports and firewalls.
These entries name the default ports. If you change njMule's ports in its options, open and forward the new ones yourself; the DSM menu entry keeps opening port 4711.
Start and stop
Use Stop and Run in Package Center. On Stop, njMule saves its downloads and settings before it exits (it is given up to a minute).
Upgrade
Install a newer .spk the same way, from Manual Install: the package is upgraded and keeps its
settings and downloads. njMule tells you when a new version is out, in a notice of its web
interface whose Details tell how to install it; it never replaces itself on DSM. See
Updates.
DSM versions are numbers only: Package Center shows njMule's version without its pre-release label (alpha, beta, release candidate), followed by a build number that grows with each package.
Uninstall
Uninstall njMule in Package Center. The uninstall wizard asks whether to delete njMule's data too (settings, server and contact lists, identity and credits, unfinished downloads and logs): tick Delete njMule's data to delete it, or leave it unticked to keep it for a later installation. The downloaded files in the shared folder njmule always stay. See Uninstall.
Why a static executable
The executable inside the package is the static one of njmule-<version>-linux-x64-static.tar.xz,
linked with musl: the C library of DSM is too old for the other Linux executables. It needs no
library of the system. See Install on Linux.