Installation tutorial for Komga on Windows

💡 Text enclosed in <> symbols needs to be modified according to the actual situation.

Download the required files#

First, download JDK 17 from the following website:

https://www.123pan.com/s/94VA-nBkVv
After downloading, extract it to a folder.
Next, download the latest version of the main program komga-<version>.jar from Komga's GitHub page:

https://github.com/gotson/komga/releases

Place both files in the same folder. After completion, it should look like this:

jdk-<version>
komga-<version>.jar

Start the komga program#

In the folder, hold down the Shift key and right-click on a blank space, then select "Open command window here" (or "Open PowerShell window here"). In the opened command/PowerShell window, enter the following command:

jdk-<version>\bin\java.exe -jar -Xmx4g komga-<version>.jar --server.port=9002

Here, -Xmx4g indicates the maximum memory allowed to be used is 4G, which is the recommended memory requirement for running Komga. If your computer has less than 4G of available memory, you can adjust this parameter accordingly. The minimum memory requirement for running is 2G. Additionally, --server.port=9002 specifies the port number for Komga as 9002, but you can choose a different port as needed.

After running the above command, Komga will start and begin running. You can access Komga's web interface by entering "http://localhost:9002" in your browser.
On the initialization page, select the language, create an administrator account, and then enter the main interface.

Add comics#

Click the "+" button on the right side of the "Libraries" page and select the root folder and name of the comics you want to add. You can also choose the root directory for all comics, and Komga will automatically scan recursively.

In the "Options" section, if you move a folder, you can select the "Clean up garbage" option to remove old, inaccessible paths. Rest assured, this will not affect the files on your hard drive.

Add users#

You can click the "+" button in the "Server settings" section on the left to add users.

Running as a Windows service#

If you don't run the program as a Windows service, you need to manually enter the command to start it. However, if you run the program as a Windows service, it can automatically start when the computer boots up.

Next, we will use easy-service to register the Windows service.

You can download Source code(zip) from https://github.com/pandolia/easy-service/releases.

After downloading, extract the files and find register-this-path.win10.bat in the bin directory. Run this file as an administrator to register the environment variables.

Next, find a directory and run the following command:

svc create komga

Then, edit the svc.conf file and locate the Worker: section. Here's an example for reference:

Worker: jdk-17.0.6\bin\java.exe -jar -Xmx4g komga-0.165.0.jar --server.port=9002

After editing, place the jdk-17.0.6 and komga-0.165.0.jar files into the worker folder. The folder structure should look like this:

komga
├─outfiles
└─worker
    └─jdk-17.0.6
    └─komga-komga-0.165.0.jar

In the komga folder, use Windows + S to search for cmd or powershell and open it as an administrator. Use the cd command to navigate to the current directory, then run the following command:

svc install

After running, the service will be installed and automatically run when Windows starts.

If you need help with managing services, please refer to easyservice-Service Operation Commands.