Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: wrong addon link in setting-default.md #317

Closed
wants to merge 1 commit into from

Conversation

aminomancer
Copy link

The instructions for a private session link required the user to install the Kagi extension, but the link to the extension is for Add custom search engine, a different extension.

The instructions for a private session link required the user to install the Kagi extension, but the link to the extension is for Add custom search engine, a different extension.
@david-ros
Copy link
Collaborator

This is actually in the Manual Configuration section for people who don't want to use Kagi's Extension, but we will be updating this with a workaround provided by another user that doesn't require installing any extension.

@david-ros david-ros closed this Dec 29, 2023
@aminomancer
Copy link
Author

aminomancer commented Dec 29, 2023

@david-ros I believe you've misunderstood the PR. Sorry if my extended description was overly brief. This is in reference to the below paragraph, which cannot possibly work for users who lack the Kagi extension. Setting up a private session link is not possible without the Kagi extension. But the paragraph doesn't link to the Kagi extension, it links to a different extension.

To set up a private session link in Firefox, install this extension. Next, click the Extensions button with the puzzle piece icon in the toolbar, then click the Gear icon next to Kagi and select Pin to toolbar in the dropdown menu. Now, click the Kagi icon in your toolbar and click the Advanced Settings button in the top right of the modal. Finally, paste your personal session link in the text field and click on Save settings.

Specifically:

Next, click the Extensions button with the puzzle piece icon in the toolbar, then click the Gear icon next to Kagi and select Pin to toolbar in the dropdown menu.

Following these instructions, there is no "Kagi" entry in the Extensions panel. That is only provided by the Kagi extension. So this paragraph should be instructing the user to install the Kagi extension. But instead, it's instructing the user to install an extension that only provides a way of adding an OpenSearch engine to user's search.json.mozlz4 file. This extension's functionality is no different than the functionality that was already suggested in the paragraph above:

Open https://kagi.com/, then right-click the browser address/search bar and select Add Kagi Search.

This does the same thing. It takes the OpenSearch description XML file on the site and generates an engine out of it, which Firefox stores in the same JSON file.

Either way, you don't get a "browser action," which seems to be the goal of this paragraph.

Also, following the first sentence in the paragraph will have no effect. Installing this extension does nothing by itself. It only provides an interface for the user to create a search engine, but the paragraph doesn't instruct the user to create a search engine. I think this was probably part of an older version of the page that suggested users install that extension in order to create the search engine. But now, it suggests users take advantage of Firefox's built-in context menu option to create a search engine, making this extension obsolete for the article's purposes.

Now, click the Kagi icon in your toolbar and click the Advanced Settings button in the top right of the modal. Finally, paste your personal session link in the text field and click on Save settings.

The "Advanced Settings button in the top right of the modal" is provided by the Kagi extension. I downloaded the source code to confirm this. There is a popup.html file that provides the browser action view.

It seems to me that an editor may have pasted the wrong link in, or accidentally conflated 2 extensions. There are 2 things at issue here:

  1. Registering a search engine with Firefox, so that it shows up in Firefox's lists of search engines. There are 3 methods to do this:
    1. Install the Kagi extension, which directly registers a search engine using the chrome_settings_overrides API.
    2. Install the Add custom search engine extension, which provides a GUI for registering any arbitrary search engine.
    3. Visit the Kagi site, which contains an OpenSearch description XML file in index.html, which Firefox automatically recognizes, and exposes an option in the address bar for generating a search engine from it.
  2. Creating a private session link, so that the user will be automatically signed into Kagi when running searches in private browsing windows, which otherwise would not happen. This functionality is only provided by the Kagi extension, it's not a feature of OpenSearch or Firefox's search engine API.

@david-ros
Copy link
Collaborator

@aminomancer: Yes, you are right that the previous instructions didn't make sense. However since this is the Manual Configuration section, the idea is to give users an alternative to installing the extension, we have already updated that section with the other workaround provided by a user, I tested it and it does work, please take a look:
https://help.kagi.com/kagi/getting-started/setting-default.html#firefox_browsers

@aminomancer
Copy link
Author

aminomancer commented Dec 29, 2023

Looks great now, thanks for letting me know.

Edit: One possible improvement is to move the images up above the "To set up a private session link in Firefox:" section. Right now it seems like they're screenshots of the private session link setup process, but really they're depicting the instructions above it (the one with 3 steps). Not a big deal though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants