Merge pull request #64 from n4ze3m/next

v1.1.7

Author: n4ze3m

.gitignore

@@ -42,4 +42,7 @@ keys.json
 
 # typescript
 .tsbuildinfo
-.wxt
+# WXT
+.wxt
+# WebStorm
+.idea 

README.md

@@ -30,6 +30,13 @@ Note: You can install the extension on any Chromium-based browser. It is not lim
 
 ### Manual Installation
 
+#### Pre-requisites
+
+- Node.js (v18 or higher) - [Installation Guide](https://nodejs.org)
+- npm
+- Ollama (Local AI Provider) - [Installation Guide](https://ollama.com)
+
+
 1. Clone the repository
 
 ```bash
@@ -43,20 +50,33 @@ cd page-assist
 npm install
 ```
 
-3. Build the extension
+3. Build the extension (by default it will build for Chrome)
 
 ```bash
 npm run build
 ```
 
-4. Load the extension
+or you can build for Firefox
+
+```bash
+npm run build:firefox
+```
+
+4. Load the extension (chrome)
 
 - Open the Extension Management page by navigating to `chrome://extensions`.
 
 - Enable Developer Mode by clicking the toggle switch next to Developer mode.
 
 - Click the `Load unpacked` button and select the `build` directory.
 
+5. Load the extension (firefox)
+
+- Open the Add-ons page by navigating to `about:addons`.
+- Click the `Extensions` tab.
+- Click the `Manage Your Extensions` button.
+- Click the `Load Temporary Add-on` button and select the `manifest.json` file from the `build` directory.
+
 ## Usage
 
 ### Sidebar
@@ -89,18 +109,18 @@ This will start a development server and watch for changes in the source files.
 | -------- | ------- | ----------------- | ------ |
 | Chrome   | ✅      | ✅                | ✅     |
 | Brave    | ✅      | ✅                | ✅     |
+| Firefox  | ✅      | ✅                | ✅     |
 | Edge     | ✅      | ❌                | ✅     |
 | Opera GX | ❌      | ❌                | ✅     |
 | Arc      | ❌      | ❌                | ✅     |
-| Firefox  | ❌      | ❌                | ❌     |
 
 ## Local AI Provider
 
 - [Ollama](https://github.com/ollama/ollama) (Currently the only supported provider. More providers will be added in the future.)
 
 ## Roadmap
 
-- [ ] Firefox Support
+- [X] Firefox Support
 - [ ] More Local AI Providers
 - [ ] More Features
 - [ ] More Customization Options

bun.lockb

@@ -0,0 +1,33 @@
+# Ollama Connection Issues
+
+Connection issues can be caused by a number of reasons. Here are some common issues and how to resolve them on Page Assist. You will see the following error message if there is a connection issue:
+
+### 1. Direct Connection Error
+![Direct connection error](https://image.pageassist.xyz/Screenshot%202024-05-13%20001742.png)
+
+### 2. `403` Error When Sending a Message
+![403 error when sending a message](https://image.pageassist.xyz/Screenshot%202024-05-13%20001940.png)
+
+This issue usually occurs when Ollama is not running on [http://127.0.0.1:11434/](http://127.0.0.1:11434/), and the connection is from the private network or a different network.
+
+### Solutions
+
+Since Ollama has connection issues when directly accessed from the browser extension, Page Assist rewrites the request headers to make it work. However, automatic rewriting of headers only works on `http://127.0.0.1:*` and `http://localhost:*` URLs. To resolve the connection issue, you can try the following solutions:
+
+1. Go to Page Assist and click on the `Settings` icon.
+
+2. Click on the `Ollama Settings` tab.
+
+3. There you will see the `Advance Ollama URL Configuration` option. You need to expand it.
+
+![Advance Ollama URL Configuration](https://image.pageassist.xyz/Screenshot%202024-05-13%20003123.png)
+
+4. Enable the `Enable or Disable Custom Origin URL` option.
+
+![Enable or Disable Custom Origin URL](https://image.pageassist.xyz/Screenshot%202024-05-13%20003225.png)
+
+5. (Optional) If Ollama is running on a different port or host, then change the URL in the `Custom Origin URL` field; otherwise, leave it as it is.
+
+This will resolve the connection issue, and you will be able to use Ollama without any issues on Page Assist ❤
+
+If you still face any issues, feel free to contact us [here](https://github.com/n4ze3m/page-assist/issues/new), and we will be happy to help you out.

docs/connection-issue.md

@@ -5,12 +5,12 @@
   "description": "Use your locally running AI models to assist you in your web browsing.",
   "author": "n4ze3m",
   "scripts": {
-    "dev": "wxt",
-    "dev:firefox": "wxt -b firefox",
-    "build": "wxt build",
-    "build:firefox": "wxt build -b firefox",
-    "zip": "wxt zip",
-    "zip:firefox": "wxt zip -b firefox",
+    "dev": "cross-env TARGET=chrome wxt",
+    "dev:firefox": "cross-env TARGET=firefox wxt -b firefox",
+    "build": "cross-env TARGET=chrome wxt build",
+    "build:firefox": "cross-env TARGET=chrome cross-env TARGET=firefox wxt build -b firefox",
+    "zip": "cross-env TARGET=chrome wxt zip",
+    "zip:firefox": "cross-env TARGET=firefox wxt zip -b firefox",
     "compile": "tsc --noEmit",
     "postinstall": "wxt prepare"
   },
@@ -66,6 +66,7 @@
     "@types/react-syntax-highlighter": "^15.5.11",
     "@types/turndown": "^5.0.4",
     "autoprefixer": "^10.4.17",
+    "cross-env": "^7.0.3",
     "postcss": "^8.4.33",
     "prettier": "3.2.4",
     "tailwindcss": "^3.4.1",

package.json

@@ -23,7 +23,7 @@ Click the button below to deploy the code to Railway.
 
 ```bash
 git clone https://github.com/n4ze3m/page-share-app.git
-cd page-assist-app
+cd page-share-app
 ```
 
 2. Run the server

page-share.md

@@ -2,7 +2,8 @@
     "ollamaState": {
         "searching": "Searching for Your Ollama 🦙",
         "running": "Ollama is running 🦙",
-        "notRunning": "Unable to connect to Ollama 🦙"
+        "notRunning": "Unable to connect to Ollama 🦙",
+        "connectionError": "It seems like you are having a connection error. Please refer to this <anchor>documentation</anchor> for troubleshooting."
     },
     "formError": {
         "noModel": "Please select a model",

src/assets/locale/en/playground.json

@@ -245,6 +245,17 @@
                 "webSearchFollowUpPromptHelp": "Do not remove `{chat_history}` and `{question}` from the prompt.",
                 "webSearchFollowUpPromptError": "Please input your Web Search Follow Up Prompt!",
                 "webSearchFollowUpPromptPlaceholder": "Your Web Search Follow Up Prompt"
+            },
+            "advanced": {
+                "label": "Advance Ollama URL Configuration",
+                "urlRewriteEnabled": {
+                    "label": "Enable or Disable Custom Origin URL"
+                },
+                "rewriteUrl": {
+                    "label": "Custom Origin URL",
+                    "placeholder": "Enter Custom Origin URL"
+                },
+                "help": "If you have connection issues with Ollama on Page Assist, you can configure a custom origin URL. To learn more about the configuration, <anchor>click here</anchor>."
             }
         }
     },

src/assets/locale/en/settings.json

@@ -2,7 +2,8 @@
     "ollamaState": {
         "searching": "Ollamaを検索中 🦙",
         "running": "Ollamaが実行中 🦙",
-        "notRunning": "Ollamaに接続できません 🦙"
+        "notRunning": "Ollamaに接続できません 🦙",
+        "connectionError": "接続エラーが発生しているようです。トラブルシューティングについては<anchor>ドキュメント</anchor>をご覧ください。"
     },
     "formError": {
         "noModel": "モデルを選択してください",

src/assets/locale/ja-JP/playground.json

@@ -248,6 +248,17 @@
                 "webSearchFollowUpPromptHelp": "プロンプトから`{chat_history}`と`{question}`を削除しないでください。",
                 "webSearchFollowUpPromptError": "Web検索フォローアッププロンプトを入力してください！",
                 "webSearchFollowUpPromptPlaceholder": "Web検索フォローアッププロンプト"
+            },
+            "advanced": {
+                "label": "Ollama URL の高度な設定",
+                "urlRewriteEnabled": {
+                    "label": "カスタムOriginのURLを有効化または無効化する"
+                },
+                "rewriteUrl": {
+                    "label": "カスタムOriginのURL",
+                    "placeholder": "カスタムOriginのURLを入力"
+                },
+                "help": "PageAssistでOllamaに接続の問題がある場合は、カスタムOriginのURLを設定できます。設定の詳細については、<anchor>ここをクリック</anchor>してください。"
             }
         }
     },