From fbc51eff6919dbecadfdb3eb2b235b188715b415 Mon Sep 17 00:00:00 2001 From: Anuj Choudhary Date: Tue, 2 Sep 2025 22:06:25 +0530 Subject: [PATCH] Added documenttations for 1. Setting up LM Studio 2. Setting up Ollama 3. Using LM Studio Open AI --- .../setting-up-lm-studio/lmstudio-step1.png | 3 ++ .../setting-up-lm-studio/lmstudio-step2.png | 3 ++ .../setting-up-lm-studio/lmstudio-step3.png | 3 ++ .../setting-up-lm-studio/lmstudio-step4-1.png | 3 ++ .../setting-up-lm-studio/lmstudio-step4-2.png | 3 ++ .../setting-up-lm-studio/lmstudio-step5.png | 3 ++ .../images/setting-up-ollama/ollama-step1.png | 3 ++ .../images/setting-up-ollama/ollama-step2.png | 3 ++ .../images/setting-up-ollama/ollama-step3.png | 3 ++ .../images/setting-up-ollama/ollama-step4.png | 3 ++ .../lm-studio-openais-step1.png | 3 ++ .../lm-studio-openais-step10.png | 3 ++ .../lm-studio-openais-step11.png | 3 ++ .../lm-studio-openais-step12.png | 3 ++ .../lm-studio-openais-step2.png | 3 ++ .../lm-studio-openais-step3.png | 3 ++ .../lm-studio-openais-step4.png | 3 ++ .../lm-studio-openais-step5.png | 3 ++ .../lm-studio-openais-step6.png | 3 ++ .../lm-studio-openais-step7.png | 3 ++ .../lm-studio-openais-step8.png | 3 ++ .../lm-studio-openais-step9.png | 3 ++ docs/setting-up-lm-studio.md | 36 +++++++++++++ docs/setting-up-ollama.md | 38 +++++++++++++ docs/using-lm-studio-openais-gpt-oss.md | 53 +++++++++++++++++++ 25 files changed, 193 insertions(+) create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step1.png create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step2.png create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step3.png create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step4-1.png create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step4-2.png create mode 100644 docs/images/setting-up-lm-studio/lmstudio-step5.png create mode 100644 docs/images/setting-up-ollama/ollama-step1.png create mode 100644 docs/images/setting-up-ollama/ollama-step2.png create mode 100644 docs/images/setting-up-ollama/ollama-step3.png create mode 100644 docs/images/setting-up-ollama/ollama-step4.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step1.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step10.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step11.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step12.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step2.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step3.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step4.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step5.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step6.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step7.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step8.png create mode 100644 docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step9.png create mode 100644 docs/setting-up-lm-studio.md create mode 100644 docs/setting-up-ollama.md create mode 100644 docs/using-lm-studio-openais-gpt-oss.md diff --git a/docs/images/setting-up-lm-studio/lmstudio-step1.png b/docs/images/setting-up-lm-studio/lmstudio-step1.png new file mode 100644 index 000000000..7820b7e4c --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8db2bfc75127269282c0933e0517713361938f9c9acadc461b7a0439f98b077c +size 499738 diff --git a/docs/images/setting-up-lm-studio/lmstudio-step2.png b/docs/images/setting-up-lm-studio/lmstudio-step2.png new file mode 100644 index 000000000..ce9d12f11 --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:13db7f68939e5b1642220645bc9034bfd9f9f1a0457d5e1c7c6f729ab2159393 +size 467640 diff --git a/docs/images/setting-up-lm-studio/lmstudio-step3.png b/docs/images/setting-up-lm-studio/lmstudio-step3.png new file mode 100644 index 000000000..c56ff785c --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:33754664f521f0f26765c4a379d839a157b9fe4c8d73f51bf9c4ed0c2ee35733 +size 448134 diff --git a/docs/images/setting-up-lm-studio/lmstudio-step4-1.png b/docs/images/setting-up-lm-studio/lmstudio-step4-1.png new file mode 100644 index 000000000..43d92f6eb --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step4-1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31a062590035b03c9a8a6181f6477c2a513f35ee063502eaf8f3e7e1291aee57 +size 429315 diff --git a/docs/images/setting-up-lm-studio/lmstudio-step4-2.png b/docs/images/setting-up-lm-studio/lmstudio-step4-2.png new file mode 100644 index 000000000..056cb990e --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step4-2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0da6041aadbf54e9cf3179e5b28fb87c4d6a512f78fa0c16cfa6f81738d8eba1 +size 444795 diff --git a/docs/images/setting-up-lm-studio/lmstudio-step5.png b/docs/images/setting-up-lm-studio/lmstudio-step5.png new file mode 100644 index 000000000..2011c6382 --- /dev/null +++ b/docs/images/setting-up-lm-studio/lmstudio-step5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fbe3d7689776d29c7b782fd103d3663f1009564002c6ca0ec5f2b6c17b779872 +size 738406 diff --git a/docs/images/setting-up-ollama/ollama-step1.png b/docs/images/setting-up-ollama/ollama-step1.png new file mode 100644 index 000000000..f984bbbb4 --- /dev/null +++ b/docs/images/setting-up-ollama/ollama-step1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fb742262ad459bc97480b1b137aa110f2bcb762644b1c9c29cfc180d91b02995 +size 428125 diff --git a/docs/images/setting-up-ollama/ollama-step2.png b/docs/images/setting-up-ollama/ollama-step2.png new file mode 100644 index 000000000..1d5d7bed2 --- /dev/null +++ b/docs/images/setting-up-ollama/ollama-step2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddec30528e9d91eb65dcdb76f5f1826f5ec903535d80a82305406cec611be666 +size 233991 diff --git a/docs/images/setting-up-ollama/ollama-step3.png b/docs/images/setting-up-ollama/ollama-step3.png new file mode 100644 index 000000000..113a9ec93 --- /dev/null +++ b/docs/images/setting-up-ollama/ollama-step3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:adee5a3163aeb332f71690564fb4d8b558a56dd9a9328f6fd5765675ce8080e3 +size 281419 diff --git a/docs/images/setting-up-ollama/ollama-step4.png b/docs/images/setting-up-ollama/ollama-step4.png new file mode 100644 index 000000000..b3f14a70f --- /dev/null +++ b/docs/images/setting-up-ollama/ollama-step4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c6ae26c56c8b9c0096685b263e6c8ac811bbb6c0d68bebeb35ef66b894b66e48 +size 526727 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step1.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step1.png new file mode 100644 index 000000000..5fc451633 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1187474cbb99962ca5018327c55d42959d5ef85da8b53d828a11c683c0fb29e0 +size 112993 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step10.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step10.png new file mode 100644 index 000000000..ef26f604f --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step10.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:79f5f61052e2f229f5a9d1d12f08809a0d9ef78bb3dd8b91e44c40592a3875d7 +size 86382 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step11.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step11.png new file mode 100644 index 000000000..3b5c320aa --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step11.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17f9ca86cdfef7b2ed133f4f4afc84db11bb3a22dd79c0e101a298ec9ec0f462 +size 462783 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step12.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step12.png new file mode 100644 index 000000000..2826aee05 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step12.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b672e5a8ca9d6b166172deda91049257e3f77da8a388e1ab250992aa34837c53 +size 447646 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step2.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step2.png new file mode 100644 index 000000000..09edcb926 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step2.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:782f8caf7088f20ca42422d19ab2aab3c191b944614e63b63dcfa986fea70205 +size 281701 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step3.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step3.png new file mode 100644 index 000000000..5937179e5 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step3.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c466b78f104f2ada7f2e4d2da906592b4086081c30611aa08991b87573a41237 +size 119208 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step4.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step4.png new file mode 100644 index 000000000..fc4cbc277 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step4.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:61397fb5956806059223b850f9102556750d984ca8a482219f05f7b678117a35 +size 158993 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step5.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step5.png new file mode 100644 index 000000000..6e6d02a3d --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step5.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0582445ec31e5fad85a43f4f529632a723c9238c6a592fb5c87a44b77168e069 +size 60134 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step6.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step6.png new file mode 100644 index 000000000..8b39bfddb --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step6.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3816bba8e3d80f4f71d7a9eee9020277f7c2b20d25da06a0c754c488f46566b7 +size 238727 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step7.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step7.png new file mode 100644 index 000000000..599e8516a --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step7.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:1ce301d8a332fe7e5208a032a46b940a52574dba02c0c6e291c49b82ac7d0e03 +size 208603 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step8.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step8.png new file mode 100644 index 000000000..fdac8b50e --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step8.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:17b387e3ab7705f32525f9d4e3f37e3195f621a569449bce0f6dfc30ea4ebb51 +size 200057 diff --git a/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step9.png b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step9.png new file mode 100644 index 000000000..463da2e83 --- /dev/null +++ b/docs/images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step9.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6caa57f5e881e03f03d4d9ee33e459d71609e776ec5e0dc0a0988a2bbe018c6b +size 76020 diff --git a/docs/setting-up-lm-studio.md b/docs/setting-up-lm-studio.md new file mode 100644 index 000000000..4942e6162 --- /dev/null +++ b/docs/setting-up-lm-studio.md @@ -0,0 +1,36 @@ +# Setting-up LM Studio with BrowserOS + +## Step 1: Open LM Studio + +Open LM Studio, navigate to the `Developer` page and select the desired model to load. + +![Open LM Studio](images/setting-up-lm-studio/lmstudio-step1.png) + +### Step 2: Load the model + +In below example I’m loading `openai/gpt-oss-20b` model + +![Load the Studio](images/setting-up-lm-studio/lmstudio-step2.png) + +### Step 3: Configure in BrowserOS + +- Navigate to `chrome://settings/browseros-ai` or `Go to Settings -> BrowserOS AI` +- Click `Add Provider` +- Select `OpenAl Compatible` in `Provider Type` dropdown + +![Configure in BrowserOS](images/setting-up-lm-studio/lmstudio-step3.png) + +### Step 4: Configure the Model + +- Replace the Base URL with LM Studio URL, default is [`http://localhost:1234/v1/`](http://localhost:1234/v1/) +- Set the Model ID to the one you loaded in LM studio +- **💥 IMPORTANT:** Ensure you set the `Context Window Size` to what you configured in LM Studio. + +![Configure the Model](images/setting-up-lm-studio/lmstudio-step4-1.png) +![Configure the Model](images/setting-up-lm-studio/lmstudio-step4-2.png) + +### Step 5: Use the model in `BrowerOS` 🐶 + +- Select the model in BrowserOS agent and start using! 🎉 + +![Use the model in BrowerOS](images/setting-up-lm-studio/lmstudio-step5.png) diff --git a/docs/setting-up-ollama.md b/docs/setting-up-ollama.md new file mode 100644 index 000000000..1d5325dac --- /dev/null +++ b/docs/setting-up-ollama.md @@ -0,0 +1,38 @@ +# Setting-up Ollama with BrowserOS + +## Steps + +1. Navigate to `chrome://settings/browseros-ai` to add Ollama as a provider. +2. Get the model ID of ollama model i.e. `gpt-oss:20b` +3. You need to start ollama with this command to prevent CORS issue `OLLAMA_ORIGINS="*" ollama serve` + - 💥 If you don’t want to run from CLI, we recommend using LM studio. See the guide here - [Setting-up LM Studio with BrowserOS](setting-up-lm-studio.md) +4. Select the model in agent and start using it! 🥳 + +## Visual Steps + +### **Step 1: Navigate to settings page `chrome://settings/browseros-ai`** + +![Navigate to settings page](images/setting-up-ollama/ollama-step1.png) + + +### **Step 2: Get the ollama model ID** + +![Get the ollama model ID](images/setting-up-ollama/ollama-step2.png) + + +### **Step 3: Start Ollama from CLI** + +`OLLAMA_ORIGINS="*" ollama serve` + +Unfortunately, Ollama by default doesn’t allow requests from other apps without this. + +💥 If you don’t want to run from CLI, we recommend using LM studio. See the guide here - [Setting-up LM Studio with BrowserOS](setting-up-lm-studio.md) + +![Start Ollama from CLI](images/setting-up-ollama/ollama-step3.png) + + +### Step 4: Use the model + +Select the model in `Agent` drop-down and start using it 🚀 + +![Use the model](images/setting-up-ollama/ollama-step4.png) diff --git a/docs/using-lm-studio-openais-gpt-oss.md b/docs/using-lm-studio-openais-gpt-oss.md new file mode 100644 index 000000000..736f98371 --- /dev/null +++ b/docs/using-lm-studio-openais-gpt-oss.md @@ -0,0 +1,53 @@ +# Using LM Studio + OpenAI’s gpt-oss + +### STEP1: Setup LMStudio and download **OpenAI GPT-OSS** + +1. Download LMStudio from https://lmstudio.ai/ + +2. Click on Discover in LMStudio, it should be the “🔍” icon on the left + +![Setup LMStudio and download OpenAI GPT-OSS](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step1.png) + +3. Search for gpt-oss-20b and click Download + +![Search for gpt-oss-20b and click Download](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step2.png) + +4. After download finishes, load the model. + +![After download finishes, load the model.](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step3.png) + +NOTE: Enable the flag to choose model parameters on load + +![Enable the flag to choose model parameters on load](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step4.png) + +Set context length to 32768, depending on your hardware and load the model + +![Set context length to 32768, depending on your hardware and load the model](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step5.png) + +### STEP2: Configure BrowserOS to use LMStudio + +1. Add Provider from `chrome://settings/browseros-ai` + +![Configure BrowserOS to use LMStudio](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step6.png) + +2. Choose Provider Type as “OpenAI Compatible” + +![Choose Provider Type as “OpenAI Compatible”](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step7.png) + +3. Set Base URL to http://127.0.0.1:1234/v1 and model ID to openai/gpt-oss-20b and set context length to 32768 and save! + +![Set Base URL-1](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step8.png) + +![Set Base URL-2](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step9.png) + +4. Change the default provider to lmstudio and you are good to go! + +![Change the default provider to lmstudio](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step10.png) + +5. You can gpt-oss from Agent! + +![You can gpt-oss from Agent](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step11.png) + +If everything is setup you should see messages on the LMStudio, like below. + +![If everything is setup you should see messages on the LMStudio](images/using-lm-studio-openais-gpt-oss/lm-studio-openais-step12.png) \ No newline at end of file