Note: I switched to using docker since its easier to update with making sure of extra steps. Click here for the guide
I too struggled on how to start komga when I first found out about it. And prolly its still a struggle for many especially if they don't know what .jar file or any code related jargon is. I thought I'll make a guide of how I run komga right now so a noob can run it more easily than scream at the internet on how to start komga for days or maybe even years (I think couple of years for me).
First you need the .jar file of the latest release from Komga's github. Then download the following to use the noob way.
Download the 'startkomga.exe' file from my releases.
But if you want to show off you are a noob hacker to others and want the log console as well like below download 'startkomga_log.exe' version.
I highly recommend using 'startkomga_log.exe' for the first time then switch over to the other version if needed so you'll be more aware if komga is running or not.
Download the 'startkomga.sh' file from my releases.
This will prolly work for all versions including MacOS (but I don't have one to test it out so feel free to let me know by raising an issue). I'm a noob too so I'm not 100% sure but 99.9% yes it should work as long as shell scripts execute.
Whether it is Windows or Linux, I first suggest you make a folder named 'Komga' or whatever name you like to have the .jar file and the .exe or .sh file in. This is done to make sure the .exe and .sh can locate the jar file more quicker without any errors. So folder structure should look somewhat like this.
└── Komga ├── komga-x.y.z.jar ├── startkomga.exe/.sh
You might need to make the shell script executable by running the following command (but make sure you change the directory of the terminal usind cd
command to the komga folder as mentioned above)
chmod +x startkomga.sh
or if you think using terminal is pro level then I got a noob version as well.
Right-click the .sh file -> Properties -> Permissions -> Make sure execute is ticked or change it to anyone or something along those lines (These should be available for ubuntu or raspberry pi)
Java is needed to run jar files so you need to do this even though you are not going to code in java.
You download the installer from the Oracle's official site and install Java.
run sudo apt install default-jre
in terminal to install java using the terminal.
[OPTIONAL:] Run java -version
in command prompt (for Windows) or terminal (for Linux) to verify if you ever feel in doubt. You need Java version 8+ (or 1.8+) to run Komga.
Just double click the .exe (for Windows) or .sh (for Linux) and it should run as long the jar file is in the same folder.
If you're running without log console you literally won't be aware of it running or not so please be patient. For the first time, I highly recommend using 'startkomga_log.exe' (for Windows) or 'Executing in terminal' (for Linux) for the first time so you'll know if komga is working or not.
For Linux, you can click just 'Execute' if you do not want the log.
IMPORTANT NOTE: Depending on the system the start up time might vary. For example, it takes around 10 seconds to start the server in my windows PC but my Raspberry Pi takes around 1 minute to start manually or around 2 minutes if automatic. So make sure to wait for a few minutes before cursing me or komga isn't working and flipping over tables. Also lauching the first time might take slightly longer as komga needs to set things up for the first time.
You can access the komga server via browser using the url http://localhost:25600
or http://IP_ADDRESS:25600
where IP_ADDRESS is the device's ip address in the network.
We can get the device's IP address using ipconfig
in Windows' command prompt or hostname -I
in Linux's terminal where the komga is run.
IMPORTANT NOTE: localhost is used if youre using komga from the device itself. ip address is needed when you try to access from a different PC/Laptop/Phone.
Possible stupid noob mistake: Make sure mobile phones are not running only in data and all devices are on the same wifi (I made this noob mistake multiple times). Also, no matter how fast 5G mobile data speed is, komga wont run unless connected to wifi.
ANOTHER NOTE: IP address might change from time to time, it can be avoided by setting a static ip address. (Its tricky to do, let me know if anyone needs me to give a short guide by raising an issue)
And with this you can follow Komga's official docs from here on out on how to use komga.
Just replace the .jar file with the latest version. Make sure the old .jar file is deleted or removed from the folder and only one .jar file (the latest one) is present in folder. Also deleting .jar file does not delete komga content so do not worry about accidentally deleting something inside komga.
For windows, CLick here
For linux, CLick here
Personal preference, I dont use windows for autostart since I run other apps in my laptop. I use autostart for my raspberry pi so all i need is to switch on (also I connected it with my harddrive so I have a large storage komga can acess)
The .exe gets the filename of the first .jar file in the same directory and runs the .jar file using java. Python's subprocess.call is the same as typing in command prompt.
The .sh file first changes directory to Komga folder or whatever name you created and then finds & runs the .jar file using java
It is possible to run the .jar file with .bat files for Windows (.bat files are Windows more or less equivalent to .sh in Linux).
The content of .bat files for komga with log console
start java -jar komga-X-Y-Z.jar
or without log console
start javaw -jar komga-X-Y-Z.jar
Double clicking should work the same way as an .exe file would. But the annoying part is you can't pin .bat files to start menu and you have to specify the .jar file name so I made .exe files using python and pyinstaller to automate the process.