Update documentation to reflect new multi-user config scenario (#550)

- Update docs to show how to use Khoj Cloud - Move self-hosting Khoj to separate section - Add page to setup Desktop app - Set default URL to Khoj Cloud URL in Obsidian, Emacs clients
khoj-ai · Nov 19, 2023 · 736744b · 736744b
2 parents a5613cb + d0e8438
commit 736744b
Show file tree

Hide file tree

Showing 24 changed files with 291 additions and 311 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -9,7 +9,7 @@
 </div>
 
 <div align="center">
-<b>An AI personal assistant for your digital brain</b>
+<b>An AI copilot for your Second Brain</b>
 
 </div>
 
@@ -24,30 +24,29 @@
 </div>
 
 ## Introduction
-Welcome to the Khoj Docs! This is the best place to [get started](./setup.md) with Khoj.
+Welcome to the Khoj Docs! This is the best place to get setup and explore Khoj's features.
 
-- Khoj is a desktop application to [search](./search.md) and [chat](./chat.md) with your notes, documents and images
-- It is an offline-first, open source AI personal assistant accessible from your [Emacs](./emacs.md), [Obsidian](./obsidian.md) or [Web browser](./web.md)
-- It works with jpeg, markdown, [notion](./notion_integration.md) org-mode, pdf files and [github repositories](./github_integration.md)
-- If you have more questions, check out the [FAQ](https://faq.khoj.dev/) - it's a live Khoj instance indexing our Github repository!
+- Khoj is an open source, personal AI
+- You can [chat](chat.md) with it about anything. When relevant, it'll use any notes or documents you shared with it to respond
+- Quickly [find](search.md) relevant notes and documents using natural language
+- It understands pdf, plaintext, markdown, org-mode files, [notion pages](notion_integration.md) and [github repositories](github_integration.md)
+- Access it from your [Emacs](emacs.md), [Obsidian](obsidian.md), [Web browser](web.md) or the [Khoj Desktop app](desktop.md)
+- You can self-host Khoj on your consumer hardware or share it with your family, friends or team from your private cloud
 
 ## Quickstart
-[Click here](./setup.md) for full setup instructions
-
-```shell
-pip install khoj-assistant && khoj
-```
+- [Try Khoj Cloud](https://app.khoj.dev) to get started quickly
+- [Read these instructions](./setup.md) to self-host a private instance of Khoj
 
 ## Overview
 <img src="https://docs.khoj.dev/assets/khoj_search_on_web.png" width="400px">
 <span>&nbsp;&nbsp;</span>
 <img src="https://docs.khoj.dev/assets/khoj_chat_on_web.png" width="400px">
 
-#### [Search](./search.md)
-  - **Local**: Your personal data stays local. All search and indexing is done on your machine.
+#### [Search](search.md)
+  - **Natural**: Use natural language queries to quickly find relevant notes and documents.
   - **Incremental**: Incremental search for a fast, search-as-you-type experience
 
-#### [Chat](./chat.md)
+#### [Chat](chat.md)
   - **Faster answers**: Find answers faster, smoother than search. No need to manually scan through your notes to find answers.
   - **Iterative discovery**: Iteratively explore and (re-)discover your notes
   - **Assisted creativity**: Smoothly weave across answers retrieval and content generation

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,12 +1,13 @@
 - Get Started
     - [Overview](README.md)
-    - [Install](setup.md)
+    - [Self-Host](setup.md)
     - [Demos](demos.md)
 - Use
     - [Features](features.md)
         - [Chat](chat.md)
         - [Search](search.md)
-    - Interfaces
+    - Clients
+        - [Desktop](desktop.md)
         - [Obsidian](obsidian.md)
         - [Emacs](emacs.md)
         - [Web](web.md)

diff --git a/docs/advanced.md b/docs/advanced.md
@@ -1,63 +1,11 @@
 
 ## Advanced Usage
-### Search across Different Languages
+
+### Search across Different Languages (Self-Hosting)
 To search for notes in multiple, different languages, you can use a [multi-lingual model](https://www.sbert.net/docs/pretrained_models.html#multi-lingual-models).<br />
 For example, the [paraphrase-multilingual-MiniLM-L12-v2](https://huggingface.co/sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2) supports [50+ languages](https://www.sbert.net/docs/pretrained_models.html#:~:text=we%20used%20the%20following%2050%2B%20languages), has good search quality and speed. To use it:
-1. Manually update `search-type > asymmetric > encoder` to `paraphrase-multilingual-MiniLM-L12-v2` in your `~/.khoj/khoj.yml` file for now. See diff of `khoj.yml` below for illustration:
-
-    ```diff
-    asymmetric:
-    -  encoder: sentence-transformers/multi-qa-MiniLM-L6-cos-v1
-    +  encoder: paraphrase-multilingual-MiniLM-L12-v2
-      cross-encoder: cross-encoder/ms-marco-MiniLM-L-6-v2
-      model_directory: "~/.khoj/search/asymmetric/"
-    ```
-
-2. Regenerate your content index. For example, by opening [\<khoj-url\>/api/update?t=force](http://localhost:42110/api/update?t=force)
-
-### Access Khoj on Mobile
-1. [Setup Khoj](/#/setup) on your personal server. This can be any always-on machine, i.e an old computer, RaspberryPi(?) etc
-2. [Install](https://tailscale.com/kb/installation/) [Tailscale](tailscale.com/) on your personal server and phone
-3. Open the Khoj web interface of the server from your phone browser.<br /> It should be `http://tailscale-ip-of-server:42110` or `http://name-of-server:42110` if you've setup [MagicDNS](https://tailscale.com/kb/1081/magicdns/)
-4. Click the [Add to Homescreen](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Add_to_home_screen) button
-5. Enjoy exploring your notes, documents and images from your phone!
-
-![](./assets/khoj_pwa_android.png?)
-
-### Use OpenAI Models for Search
-#### Setup
-1. Set `encoder-type`, `encoder` and `model-directory` under `asymmetric` and/or `symmetric` `search-type` in your `khoj.yml` (at `~/.khoj/khoj.yml`):
-   ```diff
-      asymmetric:
-   -    encoder: "sentence-transformers/multi-qa-MiniLM-L6-cos-v1"
-   +    encoder: text-embedding-ada-002
-   +    encoder-type: khoj.utils.models.OpenAI
-        cross-encoder: "cross-encoder/ms-marco-MiniLM-L-6-v2"
-   -    encoder-type: sentence_transformers.SentenceTransformer
-   -    model_directory: "~/.khoj/search/asymmetric/"
-   +    model-directory: null
-   ```
-2. [Setup your OpenAI API key in Khoj](/#/chat?id=setup)
-3. Restart Khoj server to generate embeddings. It will take longer than with the offline search models.
-
-#### Warnings
-  This configuration *uses an online model*
-  - It will **send all notes to OpenAI** to generate embeddings
-  - **All queries will be sent to OpenAI** when you search with Khoj
-  - You will be **charged by OpenAI** based on the total tokens processed
-  - It *requires an active internet connection* to search and index
-
-### Bootstrap Khoj Search for Offline Usage later
-
-You can bootstrap Khoj pre-emptively to run on machines that do not have internet access. An example use-case would be to run Khoj on an air-gapped machine.
-Note: *Only search can currently run in fully offline mode, not chat.*
-
-- With Internet
-  1. Manually download the [asymmetric text](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1), [symmetric text](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2) and [image search](https://huggingface.co/sentence-transformers/clip-ViT-B-32) models from HuggingFace
-  2. Pip install khoj (and dependencies) in an associated virtualenv. E.g `python -m venv .venv && source .venv/bin/activate && pip install khoj-assistant`
-- Without Internet
-  1. Copy each of the search models into their respective folders, `asymmetric`, `symmetric` and `image` under the `~/.khoj/search/` directory on the air-gapped machine
-  2. Copy the khoj virtual environment directory onto the air-gapped machine, activate the environment and start and khoj as normal. E.g `source .venv/bin/activate && khoj`
+1. Manually update the search config in server's admin settings page. Go to [the search config](http://localhost:42110/server/admin/database/searchmodelconfig/). Either create a new one, if none exists, or update the existing one. Set the bi_encoder to `sentence-transformers/multi-qa-MiniLM-L6-cos-v1` and the cross_encoder to `cross-encoder/ms-marco-MiniLM-L-6-v2`.
+2. Regenerate your content index from all the relevant clients. This step is very important, as you'll need to re-encode all your content with the new model.
 
 ### Query Filters
 

diff --git a/docs/assets/khoj_chat_on_desktop.png b/docs/assets/khoj_chat_on_desktop.png
diff --git a/docs/assets/khoj_search_on_desktop.png b/docs/assets/khoj_search_on_desktop.png
diff --git a/docs/chat.md b/docs/chat.md
@@ -1,38 +1,37 @@
-### Khoj Chat
-#### Overview
+## Khoj Chat
+### Overview
 - Creates a personal assistant for you to inquire and engage with your notes
 - You can choose to use Online or Offline Chat depending on your requirements
 - Supports multi-turn conversations with the relevant notes for context
 - Shows reference notes used to generate a response
 
-### Setup
+### Setup (Self-Hosting)
 #### Offline Chat
-Offline chat stays completely private and works without internet. But it is slower, lower quality and more compute intensive.
+Offline chat stays completely private and works without internet using open-source models.
 
 > **System Requirements**:
 >  - Minimum 8 GB RAM. Recommend **16Gb VRAM**
 >  - Minimum **5 GB of Disk** available
 >  - A CPU supporting [AVX or AVX2 instructions](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) is required
 >  - A Mac M1+ or [Vulcan supported GPU](https://vulkan.gpuinfo.org/) should significantly speed up chat response times
 
-- Open your [Khoj settings](http://localhost:42110/config/) and click *Enable* on the Offline Chat card
+1. Open your [Khoj offline settings](http://localhost:42110/server/admin/database/offlinechatprocessorconversationconfig/) and click *Enable* on the Offline Chat configuration.
+2. Open your [Chat model options](http://localhost:42110/server/admin/database/chatmodeloptions/) and add a new option for the offline chat model you want to use. Make sure to use `Offline` as its type. We currently only support offline models that use the [Llama chat prompt](https://replicate.com/blog/how-to-prompt-llama#wrap-user-input-with-inst-inst-tags) format. We recommend using `mistral-7b-instruct-v0.1.Q4_0.gguf`.
 
-![Configure offline chat](https://user-images.githubusercontent.com/6413477/257021364-8a2029f5-dc21-4de8-9af9-9ba6100d695c.mp4 ':include :type=mp4')
+!> **Note**: Offline chat is not supported for a multi-user scenario. The host machine will encounter segmentation faults if multiple users try to use offline chat at the same time.
 
 #### Online Chat
 Online chat requires internet to use ChatGPT but is faster, higher quality and less compute intensive.
 
 !> **Warning**: This will enable Khoj to send your chat queries and query relevant notes to OpenAI for processing
 
 1. Get your [OpenAI API Key](https://platform.openai.com/account/api-keys)
-2. Open your [Khoj Online Chat settings](http://localhost:42110/config/processor/conversation), add your OpenAI API key, and click *Save*. Then go to your [Khoj settings](http://localhost:42110/config) and click `Configure`. This will refresh Khoj with your OpenAI API key.
-
-![Configure online chat](https://user-images.githubusercontent.com/6413477/256998908-ac26e55e-13a2-45fb-9348-3b90a62f7687.mp4 ':include :type=mp4')
-
+2. Open your [Khoj Online Chat settings](http://localhost:42110/server/admin/database/openaiprocessorconversationconfig/). Add a new setting with your OpenAI API key, and click *Save*. Only one configuration will be used, so make sure that's the only one you have.
+3. Open your [Chat model options](http://localhost:42110/server/admin/database/chatmodeloptions/) and add a new option for the OpenAI chat model you want to use. Make sure to use `OpenAI` as its type.
 
 ### Use
 1. Open Khoj Chat
-    - **On Web**: Open [/chat](http://localhost:42110/chat) in your web browser
+    - **On Web**: Open [/chat](https://app.khoj.dev/chat) in your web browser
     - **On Obsidian**: Search for *Khoj: Chat* in the [Command Palette](https://help.obsidian.md/Plugins/Command+palette)
     - **On Emacs**: Run `M-x khoj <user-query>`
 2. Enter your queries to chat with Khoj. Use [slash commands](#commands) and [query filters](./advanced.md#query-filters) to change what Khoj uses to respond

diff --git a/docs/desktop.md b/docs/desktop.md
@@ -0,0 +1,23 @@
+<h1><img src="./assets/khoj-logo-sideways-500.png" width="200" alt="Khoj Logo"> Desktop</h1>
+
+> An AI copilot for your Second Brain
+
+## Features
+- **Chat**
+  - **Faster answers**: Find answers quickly, from your private notes or the public internet
+  - **Assisted creativity**: Smoothly weave across retrieving answers and generating content
+  - **Iterative discovery**: Iteratively explore and re-discover your notes
+- **Search**
+  - **Natural**: Advanced natural language understanding using Transformer based ML Models
+  - **Incremental**: Incremental search for a fast, search-as-you-type experience
+
+## Setup
+
+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/config#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*
+
+## Interface
+![](./assets/khoj_chat_on_desktop.png ':size=600px')
+![](./assets/khoj_search_on_desktop.png ':size=600px')
diff --git a/docs/desktop_installation.md b/docs/desktop_installation.md
@@ -28,5 +28,5 @@ For the Linux installation, you have to have `glibc` version 2.35 or higher. You
 If you decide you want to uninstall the application, you can uninstall it like any other application on your system. For example, on MacOS, you can drag the application to the trash. On Windows, you can uninstall it from the `Add or Remove Programs` menu. On Linux, you can uninstall it with `sudo apt remove khoj`.
 
 In addition to that, you might want to `rm -rf` the following directories:
-- `~/.khoj`
-- `~/.cache/gpt4all`
+  - `~/.khoj`
+  - `~/.cache/gpt4all`
diff --git a/docs/development.md b/docs/development.md
@@ -25,13 +25,7 @@ pip install -e .'[dev]'
    khoj -vv
    ```
 2. Configure Khoj
-   - **Via the Settings UI**: Add files, directories to index the [Khoj settings](http://localhost:42110/config) UI once Khoj has started up. Once you've saved all your settings, click `Configure`.
-   - **Manually**:
-     - Copy the `config/khoj_sample.yml` to `~/.khoj/khoj.yml`
-     - Set `input-files` or `input-filter` in each relevant `content-type` section of `~/.khoj/khoj.yml`
-       - Set `input-directories` field in `image` `content-type` section
-     - Delete `content-type` and `processor` sub-section(s) irrelevant for your use-case
-     - Restart khoj
+   - **Via the Desktop application**: Add files, directories to index using the settings page of your desktop application. Click "Save" to immediately trigger indexing.
 
   Note: Wait after configuration for khoj to Load ML model, generate embeddings and expose API to query notes, images, documents etc specified in config YAML