Running a Java Program as a Background Windows Service with NSSM

Running a Java program as a background Windows service can be a powerful way to ensure your application runs smoothly and consistently in the background. This article will guide you through the process of setting up a Java application as a Windows service using the NSSM (Non-Sucking Service Manager). Follow these steps to turn your Java application into a reliable background service.

Requirements and Prerequisites

To follow this guide, you will need:

A working installation of Java on your Windows machine. The NSSM software downloaded and extracted to a directory of your choice. Your Java application ready to run, typically as a JAR file.

Step-by-Step Guide

Step 1: Install Java

Ensure that you have Java installed on your Windows machine. You can check the installation by opening the Command Prompt and running:

java -version

If Java is not installed, you can download and install the latest version from the official Java website.

Step 2: Download and Extract NSSM

Visit the NSSM website and download the appropriate version for your system (32-bit or 64-bit). Extract the downloaded zip file to a directory of your choice.

Step 3: Prepare Your Java Application

Make sure your Java application is ready to run. Typically, this means you have a JAR file (e.g., myapp.jar) that you want to use.

Step 4: Install the Service with NSSM

Open the Command Prompt as an Administrator and navigate to the directory where you extracted NSSM. For example:

cd C:pathto ssm win64

Run the following command to install your Java application as a service:

nssm install MyJavaService

This will open a GUI window for configuring the service.

Path: Browse to your java.exe file. This is typically located in the bin folder of your Java installation, e.g., C:Program FilesJavajdk-11.0.2binjava.exe. Startup directory: Set this to the directory where your JAR file is located. Arguments: Enter the following, replacing myapp.jar with the name of your JAR file: -jar myapp.jar

Click on the Install service button.

Step 5: Start the Service

After installing the service, you can start it using the following command:

nssm start MyJavaService

Step 6: Manage the Service

You can manage the service using the following commands:

Stop the service: nssm stop MyJavaService Remove the service: nssm remove MyJavaService

Additional Considerations

Logging

You can configure logging in the NSSM GUI if your application generates logs. This can be exceptionally helpful for debugging.

Service Recovery

In the NSSM GUI, you can set recovery options to automatically restart the service if it fails.

Environment Variables

If your application requires specific environment variables, you can set them in the NSSM GUI to ensure the application runs correctly.

Conclusion

By following these steps, you can successfully run your Java application as a background Windows service using NSSM. This approach provides a simple and effective way to manage your Java applications' lifecycle on Windows.