Skip to content

Commit 6cfa132

Browse files
authored
Merge pull request #54 from Kareadita/Komf-update
Update komf.mdx
2 parents adfb46c + 682ddf6 commit 6cfa132

File tree

1 file changed

+12
-43
lines changed

1 file changed

+12
-43
lines changed

pages/guides/external-tools/komf.mdx

Lines changed: 12 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { Steps } from 'nextra/components'
1111
* Userscript for in-browser management.
1212

1313
<Callout type="info">
14-
komf does not have a webui. It's advised to use [the userscript](https://github.com/Snd-R/komf-userscript).
14+
Komf has a webui that can be used for some configuration but it's advised to use the extension for [chrome](https://chromewebstore.google.com/detail/komf/bhppjldobkpocplgfcimljjhdjgbpdnh) or [firefox](https://addons.mozilla.org/en-US/firefox/addon/komf/).
1515
</Callout>
1616

1717
## Setup
@@ -35,70 +35,39 @@ Fill out your `baseUri` to point to your Kavita install URL and put in your [Kav
3535
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.
3636
</Callout>
3737

38-
### Userscript
38+
### Extension
3939

40-
Once you have Komf running with the minimum setup posted above, we need to set up the user script to connect to it.
40+
Once you have Komf running with the minimum setup posted above, we need to set up the extension to connect to it.
4141

4242
<Steps>
4343

4444
### Step 1
4545

46-
If you don't already have a script manager add-on in your browser, set up [TamperMonkey](https://www.tampermonkey.net/). If you already running a script manager you *should* be able to use it without issue
47-
but due to subtle differences between the programs it's not always guaranteed.
46+
Install the extension following one of the links above. The chrome extension should work for chromium based browsers.
4847

49-
<Callout type="info">
50-
Because of [ManifestV3](https://developer.chrome.com/docs/extensions/develop/migrate/what-is-mv3) chrome users need to run the script manager in [Dev Mode](https://www.tampermonkey.net/faq.php#Q209)
51-
</Callout>
52-
53-
5448
### Step 2
5549

56-
Once you have your script manager installed, visit the userscript's [releases page on github](https://github.com/Snd-R/komf-userscript/releases)
50+
Click on the extension to get a dialogue box.
5751

5852
### Step 3
5953

60-
Click on `komf.user.js` for the latest release and your script manager should intercept the request.
61-
62-
### Step 4
63-
64-
Don't modify anything here. Click 'Install'
65-
66-
<Callout type="warning">
67-
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!
68-
</Callout>
69-
70-
71-
### Step 5
72-
73-
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.
74-
75-
### Step 6
76-
77-
Go to your script managers 'dashboard' and click on the newly added Komf script.
78-
79-
### Step 7
80-
81-
Go to the 'Settings' tab of the Komf script. In the `Includes/Excludes` section find `User Includes` and click Add.
82-
83-
### Step 8
84-
85-
Type in the IP / hostname of your Kavita install. You NEED to include `/*` at the end for the script manager to detect the site.
54+
Type in the IP / hostname of your Kavita install in Add new Origin.
8655

8756
Example:
8857
```bash
89-
http://192.168.0.100:5000/*
58+
http://192.168.0.100:5000
9059
```
91-
### Step 9
60+
### Step 4
9261

93-
Once the userscript is set up to recognize your Kavita you can close the script manager and open your Kavita instance.
62+
Once the extension is set up open or refresh Kavita.
9463

95-
### Step 10
64+
### Step 5
9665

97-
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!)
66+
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!) (Do note that if you use a hostname with SSL you will need to configure komf to use SSL as well otherwise you will have issues with CORS)
9867

9968
Press 'Check Connection' to test if the userscript can talk to your Komf backend. If you see a `Connected ✔` then everything is working!
10069

101-
### Step 11
70+
### Step 6
10271

10372
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.
10473
</Steps>

0 commit comments

Comments
 (0)