Install on Windows

njMule for Windows comes as an MSI installer and as a zip archive, both for x64 processors. The installer is the usual choice: a double-click or one command installs it, with no administrator rights, adds shortcuts and keeps njMule up to date. The zip runs from any folder, a USB drive included.

Download

File (njMule 0.3.1)	What it is
njmule-0.3.1-windows-x64.msi	Installer (x64; Windows on Arm runs it through its x64 emulation)
njmule-0.3.1-windows-x64.zip	Archive to unzip and run, without installing

Older versions are on the GitHub releases page. You can check the download before you open it.

Install with the MSI

Double-click

1. Download the .msi file above.
2. Double-click it, in your Downloads folder or in the browser's list of downloads. If Windows SmartScreen says it protected your PC, choose More info, then Run anyway (see SmartScreen below).
3. There is nothing to choose: the installer finishes on its own in a few seconds, for your user, without asking for administrator rights.
4. Start njMule from the Start menu or from the njMule shortcut on the desktop. At the first start, a wizard helps you set it up: see First start.

From a terminal

1. Download the .msi file above.

2. In PowerShell or the Command Prompt, in the folder that holds it, run:

   msiexec /i njmule-<version>-windows-x64.msi

   The installer finishes on its own, for your user, without asking for administrator rights; add /qn to show no window at all. The installation is the same as with a double-click.

3. Start njMule from the Start menu, from the njMule shortcut on the desktop, or with njmule-gui in a new terminal. At the first start, a wizard helps you set it up: see First start.

To install for every user, as a service or from a script, see For administrators.

The installer:

• puts the programs in %LOCALAPPDATA%\Programs\njMule;
• creates a njMule shortcut in the Start menu and on the desktop, whose windows are grouped and pinned on the taskbar as one app;
• adds that folder to your user's PATH, so that njmule works in a new terminal.

The folder holds:

File	What it is
njmule-gui.exe	the desktop app, what the shortcuts open
njmule.exe	the command line, a console program; without options it runs the engine headless
njmule-service.exe	the program of the Windows service
LICENSE.txt, NOTICE.txt, README.md	the license, the notices and the read-me

njmule-gui.exe is the desktop app's window: it starts njmule.exe, the engine, beside it and shows its interface in Microsoft Edge WebView2 (see Requirements); both carry the njMule icon and version, as Explorer and Task Manager show. The other files beside them are a library the engine loads and install.properties, which tells njMule's update check how it was installed.

Your settings and downloads are not in the program folder: see Data locations. By default, completed downloads go to %USERPROFILE%\Downloads\njMule.

Run from the zip

1. Download njmule-<version>-windows-x64.zip.
2. Unpack it into a folder of your own, such as C:\Users\you\Apps: a folder you can write to lets njMule update itself there.
3. Double-click njmule-gui.exe in the folder njmule-<version>-windows-x64.

The zip holds the same programs as the installer, and adds nothing to the Start menu, the desktop or the PATH. In a terminal, run the command line from its folder:

.\njmule.exe --help

To keep all of njMule's data beside the programs, on a USB drive for example, put an empty file named portable.flag next to them: see Portable mode.

SmartScreen

The programs and the installer are not code-signed yet, so Windows SmartScreen may stop them the first time with "Windows protected your PC". Choose More info, check that the file is the one you downloaded, then Run anyway. Verifying the download tells you that it is the file the njMule project built.

Windows on Arm

GraalVM, which njMule's engine is built with, does not support Windows on Arm yet. Install the same x64 package: Windows runs it through its x64 emulation.

Firewall

When njMule first listens on its ports, Windows Defender Firewall may ask whether to allow it. Allow it on private networks, so that other clients can reach you; see Ports and firewalls for the router.

ed2k links from the browser

njMule can open the ed2k:// links you click in a browser. This is off by default, so that it does not take them from another program: turn on Open ed2k links with njMule (from browsers and other programs) in Options → General. See eD2K links.

Upgrade

• Installer: double-click a newer MSI, or run msiexec /i on it; it replaces the old version and keeps your settings and downloads. An older MSI refuses to replace a newer version.
• Zip: unpack the new archive in place of the old one, or let njMule do it.

njMule tells you when a new version is out and can download and install it for you, running the new installer or replacing the files of the zip: see Updates.

Uninstall

Uninstall njMule from Settings → Apps, as any other program. The uninstaller:

• closes njMule if it runs, once it has saved its state;
• gives the ed2k links back to the program that opened them before, such as eMule, if njMule still opens them, and turns Start njMule when I log in off;
• asks whether to delete your data too (settings, lists, identity and credits, unfinished downloads, caches and logs): tick Delete my njMule data to move it to the Recycle Bin, or leave it unticked to keep it for a later installation. It does not ask during an upgrade or a silent uninstall.

Your completed downloads always stay. For the zip, delete its folder; njmule --remove-profile deletes your profile first, after asking. See Uninstall and Remove your profile.

For administrators

What follows is for those who install njMule for all the users of a computer, as a service or from a script. The installer has no window in which to choose these, so they take a command in a terminal.

As a Windows service

njMule can also run as the Windows service njMule: headless, with its web interface, started with Windows before anyone logs in. Install njMule with a double-click as above, then run in a terminal:

njmule --service=install

Windows asks for the administrator's rights, then njMule for the web interface password. Everything about it is in Windows service.

For every user

A per-machine installation, in C:\Program Files\njMule for all the users of the computer, needs administrator rights. Run the installer from a terminal opened as administrator:

msiexec /i njmule-<version>-windows-x64.msi MSIINSTALLPERUSER=""

Each user still has a profile of their own. The same installation can set the service up at once when you also give it NJMULE_SERVICE=1 and a file whose first line is the web interface password (8 characters at least):

msiexec /i njmule-<version>-windows-x64.msi MSIINSTALLPERUSER="" NJMULE_SERVICE=1 NJMULE_WEBUI_PASSWORD_FILE=C:\Users\you\webui-password.txt

Add NJMULE_WEBUI_LAN=1 to let the other computers of the network reach its web interface, which otherwise answers on this computer only.

The installer refuses NJMULE_SERVICE=1 without administrator rights or without the password file. njMule keeps only a hash of the password, so you can delete the file afterwards. An upgrade stops the service while it replaces the files and starts it again; uninstalling njMule removes the service and keeps its profile in %ProgramData%\njMule.

Unattended installation

msiexec installs without any window with /qn, for your user unless you add MSIINSTALLPERUSER="":

msiexec /i njmule-<version>-windows-x64.msi /qn