diff --git a/documentation/docs/clients/desktop.md b/documentation/docs/clients/desktop.md index d32d1ac4..104c10fa 100644 --- a/documentation/docs/clients/desktop.md +++ b/documentation/docs/clients/desktop.md @@ -21,11 +21,17 @@ Khoj will keep these files in sync to provide contextual responses when you sear - **Incremental**: Incremental search for a fast, search-as-you-type experience ## Setup +:::info[Self Hosting] +If you are self-hosting the Khoj server, update the *Settings* page on the Khoj Desktop app to: +- Set the `Khoj URL` field to your Khoj server URL. By default, use `http://127.0.0.1:42110`. +- Do not set the `Khoj API Key` field if your Khoj server runs in anonymous mode. For example, `khoj --anonymous-mode` +::: + 1. Install the [Khoj Desktop app](https://khoj.dev/downloads) for your OS 2. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients) 3. Set your Khoj API Key on the *Settings* page of the Khoj Desktop app -4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save* +4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save*. These files and folders will be automatically kept in sync for you ## Interface diff --git a/documentation/docs/clients/emacs.md b/documentation/docs/clients/emacs.md index 6c751927..8acbf982 100644 --- a/documentation/docs/clients/emacs.md +++ b/documentation/docs/clients/emacs.md @@ -30,6 +30,12 @@ sidebar_position: 2 | ![khoj search on emacs](/img/khoj_search_on_emacs.png) | ![khoj chat on emacs](/img/khoj_chat_on_emacs.png) | ## Setup +:::info[Self Hosting] +If you are self-hosting the Khoj server modify the install steps below: +- Set `khoj-server-url` to your Khoj server URL. By default, use `http://127.0.0.1:42110`. +- Do not set `khoj-api-key` if your Khoj server runs in anonymous mode. For example, `khoj --anonymous-mode` +::: + 1. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients) 2. Add below snippet to your Emacs config file, usually at `~/.emacs.d/init.el` @@ -43,6 +49,7 @@ M-x package-install khoj ; Set your Khoj API key (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY") +(setq khoj-server-url "https://app.khoj.dev") ``` #### **Minimal Install** @@ -54,7 +61,8 @@ M-x package-install khoj :ensure t :pin melpa-stable :bind ("C-c s" . 'khoj) - :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY")) + :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY" + khoj-server-url "https://app.khoj.dev")) ``` #### **Standard Install** @@ -67,6 +75,7 @@ M-x package-install khoj :pin melpa-stable :bind ("C-c s" . 'khoj) :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY" + khoj-server-url "https://app.khoj.dev" khoj-org-directories '("~/docs/org-roam" "~/docs/notes") khoj-org-files '("~/docs/todo.org" "~/docs/work.org"))) ``` @@ -81,6 +90,7 @@ M-x package-install khoj :straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el")) :bind ("C-c s" . 'khoj) :config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY" + khoj-server-url "https://app.khoj.dev" khoj-org-directories '("~/docs/org-roam" "~/docs/notes") khoj-org-files '("~/docs/todo.org" "~/docs/work.org"))) ``` diff --git a/documentation/docs/clients/obsidian.md b/documentation/docs/clients/obsidian.md index 0372ecbe..d87b4882 100644 --- a/documentation/docs/clients/obsidian.md +++ b/documentation/docs/clients/obsidian.md @@ -20,11 +20,18 @@ sidebar_position: 3 - **Discover**: Find similar notes to the current one ## Setup +:::info[Self Hosting] +If you are self-hosting the Khoj server, update the Khoj Obsidian plugin settings step below: +- Set the `Khoj URL` field to your Khoj server URL. By default, use `http://127.0.0.1:42110`. +- Do not set the `Khoj API Key` field if your Khoj server runs in anonymous mode. For example, `khoj --anonymous-mode` +::: - 1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel - 2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian - 3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients) - 4. Set your Khoj API Key in the Khoj plugin settings in Obsidian +1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel +2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian +3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients) +4. Set your Khoj API Key in the Khoj plugin settings on Obsidian +5. (Optional) Click `Force Sync` in the Khoj plugin settings on Obsidian to immediately sync your Obsidian vault. +
By default, your Obsidian vault is automatically synced periodically. See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for more details on installing Obsidian plugins.