Komf
- Separate server that listens to
Series Addevents from Kavita and can scrape a number of configurable sources - Actively developed with support from the developer in Kavita discord
- Supports writing directly to Kavita’s DB via the API or saving to ComicInfo.xml inside files.
- Can automate using its own API or CLI commands.
- Userscript for in-browser management.
komf does not have a webui. It’s advised to use the userscript.
Setup
To get started with komf you need to create a file called application.yml in the same folder that komf runs from. That means if your using the .jar file it should be in the same folder.
If you are running docker then you need to define a /config folder where the file can live.
The minimum application.yml file needed to start Komf is:
kavita:
baseUri: "http://localhost:5000" #or env:KOMF_KAVITA_BASE_URI
apiKey: "YOUR_API_KEY_HERE!" #or env:KOMF_KAVITA_API_KEY
database:
file: ./database.sqlite # database file location.Fill out your baseUri to point to your Kavita install URL and put in your Kavita API key.
The API key you use will be the user that Komf is logging in as. Make sure that the user has the correct permissions in Kavita to do what you’re asking of it.
Userscript
Once you have Komf running with the minimum setup posted above, we need to set up the user script to connect to it.
Step 1
If you don’t already have a script manager add-on in your browser, set up TamperMonkey. If you already running a script manager you should be able to use it without issue but due to subtle differences between the programs it’s not always guaranteed.
Because of ManifestV3 chrome users need to run the script manager in Dev Mode
Step 2
Once you have your script manager installed, visit the userscript’s releases page on github
Step 3
Click on komf.user.js for the latest release and your script manager should intercept the request.
Step 4
Don’t modify anything here. Click ‘Install’
Modifying the script directly breaks the auto-update function and will require you to manually set up your includes every time. Just don’t change anything here!
Step 5
After installing the script, open up the script manager. It can usually be found in the top right of your browser where your other add-ons are.
Step 6
Go to your script managers ‘dashboard’ and click on the newly added Komf script.
Step 7
Go to the ‘Settings’ tab of the Komf script. In the Includes/Excludes section find User Includes and click Add.
Step 8
Type in the IP / hostname of your Kavita install. You NEED to include /* at the end for the script manager to detect the site.
Example:
http://192.168.0.100:5000/*Step 9
Once the userscript is set up to recognize your Kavita you can close the script manager and open your Kavita instance.
Step 10
Inside your Kavita’s browser window, you will now see a jigsaw puzzle piece in the top right corner next to your username. Click on it and put in your IP address of where komf is located. (This is NOT your kavita URL!)
Press ‘Check Connection’ to test if the userscript can talk to your Komf backend. If you see a Connected ✔ then everything is working!
Step 11
Now you can configure the rest of the settings for some directly from here. You can pick your providers, what libraries you want to apply against and any discord notifications to be sent.