diff --git a/docs/src/pages/docs/_assets/settings-03.png b/docs/src/pages/docs/_assets/settings-03.png index c4dba383b..3ad74da28 100644 Binary files a/docs/src/pages/docs/_assets/settings-03.png and b/docs/src/pages/docs/_assets/settings-03.png differ diff --git a/docs/src/pages/docs/_assets/settings-10.png b/docs/src/pages/docs/_assets/settings-10.png index 3d6293ce1..22d8dd0c7 100644 Binary files a/docs/src/pages/docs/_assets/settings-10.png and b/docs/src/pages/docs/_assets/settings-10.png differ diff --git a/docs/src/pages/docs/_assets/settings-11.png b/docs/src/pages/docs/_assets/settings-11.png index 38175da51..ef5706c73 100644 Binary files a/docs/src/pages/docs/_assets/settings-11.png and b/docs/src/pages/docs/_assets/settings-11.png differ diff --git a/docs/src/pages/docs/_assets/settings-12.png b/docs/src/pages/docs/_assets/settings-12.png index af09c656a..da5779865 100644 Binary files a/docs/src/pages/docs/_assets/settings-12.png and b/docs/src/pages/docs/_assets/settings-12.png differ diff --git a/docs/src/pages/docs/_assets/settings-13.png b/docs/src/pages/docs/_assets/settings-13.png new file mode 100644 index 000000000..7467755d5 Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-13.png differ diff --git a/docs/src/pages/docs/_assets/settings-14.png b/docs/src/pages/docs/_assets/settings-14.png new file mode 100644 index 000000000..11e107cde Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-14.png differ diff --git a/docs/src/pages/docs/_assets/settings-15.png b/docs/src/pages/docs/_assets/settings-15.png new file mode 100644 index 000000000..a98ce3498 Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-15.png differ diff --git a/docs/src/pages/docs/_assets/settings-16.png b/docs/src/pages/docs/_assets/settings-16.png new file mode 100644 index 000000000..72a61ca31 Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-16.png differ diff --git a/docs/src/pages/docs/_assets/settings-17.png b/docs/src/pages/docs/_assets/settings-17.png new file mode 100644 index 000000000..60142b772 Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-17.png differ diff --git a/docs/src/pages/docs/_assets/settings-18.png b/docs/src/pages/docs/_assets/settings-18.png new file mode 100644 index 000000000..11a3f3e37 Binary files /dev/null and b/docs/src/pages/docs/_assets/settings-18.png differ diff --git a/docs/src/pages/docs/built-in/llama-cpp.mdx b/docs/src/pages/docs/built-in/llama-cpp.mdx index 5b7b0453a..5b4525f31 100644 --- a/docs/src/pages/docs/built-in/llama-cpp.mdx +++ b/docs/src/pages/docs/built-in/llama-cpp.mdx @@ -57,9 +57,7 @@ Enable the GPU acceleration option within the Jan application by following the [ ### Step 1: Open the `model.json` 1. Navigate to the **Advanced Settings**. -
-![Settings](../_assets/advance-set.png) -
+ 2. On the **Jan Data Folder** click the **folder icon (📂)** to access the data.
![Jan Data Folder](../_assets/data-folder.png) diff --git a/docs/src/pages/docs/desktop/mac.mdx b/docs/src/pages/docs/desktop/mac.mdx index 7f5596af8..709d1229d 100644 --- a/docs/src/pages/docs/desktop/mac.mdx +++ b/docs/src/pages/docs/desktop/mac.mdx @@ -82,7 +82,7 @@ Keep in mind that this build might crash frequently or contain bugs! -Nightly releases are for internal team to test new feature builds everyday, which is very be buggy: +Nightly releases are for internal team to test new feature builds everyday, which is very buggy: [Download Jan's Nightly Version](https://app.jan.ai/download/nightly/mac-universal) diff --git a/docs/src/pages/docs/desktop/windows.mdx b/docs/src/pages/docs/desktop/windows.mdx index 4b32de1c6..921a4693c 100644 --- a/docs/src/pages/docs/desktop/windows.mdx +++ b/docs/src/pages/docs/desktop/windows.mdx @@ -88,7 +88,7 @@ Keep in mind that this build might crash frequently or contain bugs! -Nightly releases are for internal team to test new feature builds everyday, which is very be buggy: +Nightly releases are for internal team to test new feature builds everyday, which is very buggy: [Download Jan's Nightly Version](https://app.jan.ai/download/nightly/win-x64) diff --git a/docs/src/pages/docs/extensions.mdx b/docs/src/pages/docs/extensions.mdx index b660b365f..8d13f7310 100644 --- a/docs/src/pages/docs/extensions.mdx +++ b/docs/src/pages/docs/extensions.mdx @@ -323,9 +323,7 @@ To turn off the extension, follow the steps below: ![Extensions](./_assets/extensions-page2.png)
3. Click the slider button to turn off the extension. -
-![Extensions](./_assets/turn-off.png) -
+ 4. Restart the app to see that the extension has been disabled. ## Model Management diff --git a/docs/src/pages/docs/quickstart.mdx b/docs/src/pages/docs/quickstart.mdx index f3abc08c5..dcc7f3bd4 100644 --- a/docs/src/pages/docs/quickstart.mdx +++ b/docs/src/pages/docs/quickstart.mdx @@ -43,7 +43,7 @@ Once installed, you'll see the Jan application interface with no local models pr ### Step 2: Download a Model Jan offers various local AI models, from smaller efficient models to larger more capable ones: -1. Go to the **Hub** +1. Go to **Hub** 2. Browse available models and click on any model to see details about it 3. Choose a model that fits your needs & hardware specifications 4. Click **Download** to begin installation @@ -64,7 +64,7 @@ While the model downloads, let's optimize your hardware setup. If you have a com 3. App reload is required after the selection -Ensure you have installed all [required dependencies](docs/troubleshooting#step-1-verify-hardware-and-system-requirements) and drivers before enabling GPU acceleration. See **GPU Setup Guide** on [Windows](/docs/desktop/windows#gpu-acceleration) & [Linux](/docs/desktop/linux#gpu-acceleration) for detailed instructions. +Ensure you have installed all required dependencies and drivers before enabling GPU acceleration. See **GPU Setup Guide** on [Windows](/docs/desktop/windows#gpu-acceleration) & [Linux](/docs/desktop/linux#gpu-acceleration) for detailed instructions.
diff --git a/docs/src/pages/docs/settings.mdx b/docs/src/pages/docs/settings.mdx index 359df56ce..f3b8e3adc 100644 --- a/docs/src/pages/docs/settings.mdx +++ b/docs/src/pages/docs/settings.mdx @@ -35,7 +35,7 @@ Settings are stored in a `cortex.db` file in [Jan Data Folder](/docs/data-folder ## My models -Here's where you can manage all your installed AI models. +Here's at **Settings** () > **My Models** you can manage all your installed AI models: ### Manage Downloaded Models @@ -66,8 +66,6 @@ Use the same instructions in [Delete Local Models](/docs/models/manage-models#de #### Start Models - -You can start downloaded model from **My Models**: 1. Choose the model you want to start 2. Click **three dots** icon next to the model 3. Select **Start Model** @@ -79,9 +77,8 @@ You can start downloaded model from **My Models**: ### Manage Cloud Models -You can add and configure **Cloud Providers** here: -1. Click the **Add** () icon next to the provider name (e.g., Anthropic, Cohere, Groq), add API Key to use. See detailed instructions for each provider [here](/docs/remote-models/openai). -2. Once a provider is installed, you can manage its settings by clicking on the **Settings** () icon next to it. +1. To install cloud models, click the **Add** () icon next your preferred providers (e.g., Anthropic, Cohere, Groq), and add **API Key** to use. See [detailed instructions](/docs/remote-models/openai) for each provider. +2. Once a provider is installed, you can use its models & manage its settings by clicking on the **Settings** () icon next to it.
![Manage Cloud Provider](./_assets/settings-03.png) @@ -89,6 +86,8 @@ You can add and configure **Cloud Providers** here: ## Preferences +At **Settings** () > **Preferences**, you can customize how Jan looks. + ### Appearance & Theme Control the visual theme of Jan's interface. - **Joi Light:** Clean, bright theme for daytime use @@ -107,7 +106,7 @@ To change: ![Appearance](./_assets/settings-04.png)
-### Chat width +### Chat Width Adjust how chat content is displayed. 1. In **Chat Width** section, select either - **Full Width:** Maximizes the chat area to use the full width of the window. This is ideal for viewing longer messages or when working with code snippets that benefit from more horizontal space. @@ -129,6 +128,7 @@ Jan includes a built-in spell check feature to help catch typing errors in your
## Keyboard Shortcuts +At **Settings** () > **Keyboard shortcuts**, you can see Jan's shortcuts list: **1. Thread Management** - `⌘ N` - Create a new thread @@ -147,8 +147,47 @@ Jan includes a built-in spell check feature to help catch typing errors in your > Note: On **Windows** and **Linux**, use `Ctrl` (Control) instead of `⌘` (Command) ## Hardware +At **Settings** () > **Hardware**, you can monitor and manage your system resources when running local models. + +### CPU & RAM + + +See detailed minimum system requirements to run local models on [Mac](/docs/desktop/mac#compatibility), [Windows](/docs/desktop/windows#compatibility) & [Linux](/docs/desktop/linux#compatibility). + + +- **CPU:** important for model processing speed. With CPU only, 20-90% usage during model running is normal. + +- **RAM:** + - Different models require different amounts of RAM. + - When running local models, please keep at least **4GB free**. + - If usage is near max, try closing other applications or use smaller models. + + +### GPU Acceleration + + +Ensure you have installed all required dependencies and drivers before enabling GPU acceleration. See **GPU Setup Guide** on [Windows](/docs/desktop/windows#gpu-acceleration) & [Linux](/docs/desktop/linux#gpu-acceleration) for detailed instructions. + + +Turn on GPU acceleration to improve performance: +1. Select and **enable** your prefered GPU(s) +2. App reload is required after the selection + +
+![Hardware](./_assets/trouble-shooting-01.png) +
+ +**GPU Performance Optimization** +- Monitor VRAM usage - should not exceed 90%. Higher **VRAM** capacity typically enables better performance for larger language models. +- Adjust `ngl` ([number of GPU Layers](/docs/models/model-parameters#engine-parameters)) in **Model** settings: + - Higher NGL = more VRAM used with faster performance + - Lower NGL = Less VRAM used with slower performance + - Start with 35 layers for 8GB VRAM. Increase if you have more VRAM available & decrease if you see **out-of-memory** errors. + + ## Privacy +At **Settings** () > **Privacy**, you can control analytics & logs in Jan: ### Analytics Jan is built with privacy at its core. By default, no data is collected. Everything stays local on your device. @@ -170,15 +209,14 @@ Read more about that we collect with opt-in users at [Privacy](/docs/privacy). - Logs are stored at: - App log: `~/Library/Application\ Support/jan/data/logs/app.log` - Cortex log: `~/Library/Application\ Support/jan/data/logs/cortex.log` -- At **Logs**, click icon to open App Logs & Cortex Logs: +- To open logs from Jan's interface: at **Logs**, click icon to open App Logs & Cortex Logs:
![View Logs](./_assets/settings-08.png)
#### Clear Logs - -Click the **Clear** button to remove all logs from the Jan app: +Jan retains your logs for only **24 hours**. To remove all logs from Jan, at **Clear Logs**, click the **Clear** button: This action cannot be undone. @@ -190,13 +228,22 @@ This action cannot be undone. ## Advanced Settings - +At **Settings** () > **Advanced Settings**, Jan stores settings for advanced use cases. ### Experimental Mode Experimental features are unstable and are recommended only for testing purposes. Please turn on with caution! -To try out new features that are still in testing phase, turn on **Experimental Mode** setting: +Current experimental features: + +| Feature | Description | +|---------|-------------| +| [Tools](/docs/tools/retrieval) | Advanced tooling capabilities including web search, file operations, and code interpretation | +| Vulkan Settings | GPU acceleration using Vulkan API for improved model performance | +| [Jan Quick Ask](/docs/settings#jan-quick-ask) | Streamlined interface for rapid AI queries and responses | + + +To try out these beta features, turn on **Experimental Mode** setting:
![Experimental Mode](./_assets/settings-10.png)
@@ -205,7 +252,7 @@ To try out new features that are still in testing phase, turn on **Experimental Jan stores your data locally in your own filesystem in a universal file format. See detailed [Jan Folder Structure](docs/data-folder#folder-structure). #### Open Jan Data Folder -At **Jan Data Folder**, click icon to open Jan application's folder: +At **Settigns** > **Jan Data Folder**, click icon to open Jan application's folder:
![Open Jan Data Folder](./_assets/settings-11.png)
@@ -226,12 +273,86 @@ An app restart will be required afterward.
### HTTPs Proxy +HTTPS Proxy encrypts data between your browser and the internet, making it hard for outsiders to intercept or read. It also helps you maintain your privacy and security while bypassing regional restrictions on the internet. + + +- Model download speeds may be affected due to the encryption/decryption process and your cloud service provider's networking +- HTTPS Proxy does not affect the remote model usage. + + +1. **Enable** the proxy toggle +2. Enter your proxy server details in the following format: +``` +http://:@: +``` +Where: +- ``: Your proxy username (if authentication is required) +- ``: Your proxy password (if authentication is required) +- ``: Your proxy server's domain name or IP address +- ``: The port number for the proxy server + +
+![HTTPs Proxy](./_assets/settings-13.png) +
+ +**Ignore SSL Certificates** + +This setting allows Jan to accept self-signed or unverified SSL certificates. This may be necessary when: +- Working with corporate proxies using internal certificates +- Testing in development environments +- Connecting through specialized network security setups + + +Only enable this option if you trust your network environment. + + +
+![Ignore SSL Certificates](./_assets/settings-14.png) +
+ +### Jan Quick Ask +Jan Quick Ask provides a faster way to interact with Jan without opening the full application window. It's designed for quick queries and responses when you need immediate assistance. + + This feature is currently experimental and must be enabled through [Experimental Mode](/docs/settings#experimental-mode) in **Advanced Settings**. + + +1. Once you've turned on [Experimental Mode](/docs/settings#experimental-mode), toggle on **Jan Quick Ask** +2. App restart is required upon selection + +
+![Jan Quick Ask](./_assets/settings-15.png) +
+ +3. Once enabled, you can open **Quick Ask** overlay with default shortcut: `CMD/Ctr` + `J` + +
+![Jan Quick Ask](./_assets/settings-16.png) +
### Factory Reset +Reset to Factory Settings restores Jan to its initial state by erasing all user data, including downloaded models and chat history. This action is irreversible and should only be used as a last resort when experiencing serious application issues. -## Engines + +This action cannot be undone. All data will be permanently deleted. + -## Extensions +Only use factory reset if: +- The application is corrupted +- You're experiencing persistent technical issues that other solutions haven't fixed +- You want to completely start fresh with a clean installation + +To begin the process: +1. At **Reset to Factory Settings**, click **Reset** button +
+![Jan Quick Ask](./_assets/settings-17.png) +
+2. In the confirmation dialog: +- Type the word **RESET** to confirm +- Optionally check **Keep the current app data location** to maintain the same data folder +- Click **Reset Now** +3. App restart is required upon confirmation +
+![Jan Quick Ask](./_assets/settings-18.png)