mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-30 19:03:01 +01:00
129 lines
6.1 KiB
Markdown
129 lines
6.1 KiB
Markdown
## Setup
|
|
These are the general setup instructions for Khoj.
|
|
|
|
- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine
|
|
- Check the [Khoj Emacs docs](/emacs?id=setup) to setup Khoj with Emacs<br />
|
|
Its simpler as it can skip the server *install*, *run* and *configure* step below.
|
|
- Check the [Khoj Obsidian docs](/obsidian?id=_2-setup-plugin) to setup Khoj with Obsidian<br />
|
|
Its simpler as it can skip the *configure* step below.
|
|
|
|
### 1. Install
|
|
|
|
#### 1.1 Local Server Setup
|
|
Run the following command in your terminal to install the Khoj backend.
|
|
|
|
- On Linux/MacOS
|
|
```shell
|
|
python -m pip install khoj-assistant
|
|
```
|
|
|
|
- On Windows
|
|
```shell
|
|
py -m pip install khoj-assistant
|
|
```
|
|
For more detailed Windows installation and troubleshooting, see [Windows Install](./windows_install.md).
|
|
|
|
|
|
##### 1.1.1 Local Server Start
|
|
|
|
Run the following command from your terminal to start the Khoj backend and open Khoj in your browser.
|
|
|
|
```shell
|
|
khoj
|
|
```
|
|
|
|
Khoj should now be running at http://localhost:42110. You can see the web UI in your browser.
|
|
|
|
Note: To start Khoj automatically in the background use [Task scheduler](https://www.windowscentral.com/how-create-automated-task-using-task-scheduler-windows-10) on Windows or [Cron](https://en.wikipedia.org/wiki/Cron) on Mac, Linux (e.g with `@reboot khoj`)
|
|
|
|
#### 1.2 Local Docker Setup
|
|
Use the sample docker-compose [in Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml) to run Khoj in Docker. To start the container, run the following command in the same directory as the docker-compose.yml file. You'll have to configure the mounted directories to match your local knowledge base.
|
|
|
|
```shell
|
|
docker-compose up
|
|
```
|
|
|
|
Khoj should now be running at http://localhost:42110. You can see the web UI in your browser.
|
|
|
|
#### 1.3 Download the desktop client [Optional]
|
|
|
|
You can use our desktop executables to select file paths and folders to index. You can simply select the folders or files, and they'll be automatically uploaded to the server. Once you specify a file or file path, you don't need to update the configuration again; it will grab any data diffs dynamically over time. This part is currently optional, but may make setup and configuration slightly easier. It removes the need for setting up custom file paths for your Khoj data configurations.
|
|
|
|
**To download the desktop client, go to https://download.khoj.dev** and the correct executable for your OS will automatically start downloading. Once downloaded, you can configure your folders for indexing using the settings tab. To set your chat configuration, you'll have to use the web interface for the Khoj server you setup in the previous step.
|
|
|
|
### 1.4 Use (deprecated) desktop builds
|
|
|
|
Before `v0.12.0``, we had self-contained desktop builds that included both the server and the client. These were difficult to maintain, but are still available as part of earlier releases. To find setup instructions, see here:
|
|
|
|
- [Desktop Installation](desktop_installation.md)
|
|
- [Windows Installation](windows_install.md)
|
|
|
|
### 2. Configure
|
|
1. Set `File`, `Folder` and hit `Save` in each Plugins you want to enable for Search on the Khoj config page
|
|
2. Add your OpenAI API key to Chat Feature settings if you want to use Chat
|
|
3. Click `Configure` and wait. The app will download ML models and index the content for search and (optionally) chat
|
|
|
|
|
|
|
|
### 3. Install Interface Plugins (Optional)
|
|
Khoj exposes a web interface to search, chat and configure by default.<br />
|
|
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs.
|
|
|
|
- **Khoj Obsidian**:<br />
|
|
[Install](/obsidian?id=_2-setup-plugin) the Khoj Obsidian plugin
|
|
|
|
- **Khoj Emacs**:<br />
|
|
[Install](/emacs?id=setup) khoj.el
|
|
|
|
|
|
## Upgrade
|
|
### Upgrade Khoj Server
|
|
```shell
|
|
pip install --upgrade khoj-assistant
|
|
```
|
|
|
|
*Note: To upgrade to the latest pre-release version of the khoj server run below command*
|
|
```shell
|
|
# Maps to the latest commit on the master branch
|
|
pip install --upgrade --pre khoj-assistant
|
|
```
|
|
|
|
### Upgrade Khoj on Emacs
|
|
- Use your Emacs Package Manager to Upgrade
|
|
- See [khoj.el package setup](/emacs?id=setup) for details
|
|
|
|
### Upgrade Khoj on Obsidian
|
|
- Upgrade via the Community plugins tab on the settings pane in the Obsidian app
|
|
- See the [khoj plugin setup](/obsidian.md?id=_2-setup-plugin) for details
|
|
|
|
## Uninstall
|
|
1. (Optional) Hit `Ctrl-C` in the terminal running the khoj server to stop it
|
|
2. Delete the khoj directory in your home folder (i.e `~/.khoj` on Linux, Mac or `C:\Users\<your-username>\.khoj` on Windows)
|
|
5. You might want to `rm -rf` the following directories:
|
|
- `~/.khoj`
|
|
- `~/.cache/gpt4all`
|
|
3. Uninstall the khoj server with `pip uninstall khoj-assistant`
|
|
4. (Optional) Uninstall khoj.el or the khoj obsidian plugin in the standard way on Emacs, Obsidian
|
|
|
|
## Troubleshoot
|
|
|
|
#### Install fails while building Tokenizer dependency
|
|
- **Details**: `pip install khoj-assistant` fails while building the `tokenizers` dependency. Complains about Rust.
|
|
- **Fix**: Install Rust to build the tokenizers package. For example on Mac run:
|
|
```shell
|
|
brew install rustup
|
|
rustup-init
|
|
source ~/.cargo/env
|
|
```
|
|
- **Refer**: [Issue with Fix](https://github.com/khoj-ai/khoj/issues/82#issuecomment-1241890946) for more details
|
|
|
|
#### Search starts giving wonky results
|
|
- **Fix**: Open [/api/update?force=true](http://localhost:42110/api/update?force=true) in browser to regenerate index from scratch
|
|
- **Note**: *This is a fix for when you perceive the search results have degraded. Not if you think they've always given wonky results*
|
|
|
|
#### Khoj in Docker errors out with \"Killed\" in error message
|
|
- **Fix**: Increase RAM available to Docker Containers in Docker Settings
|
|
- **Refer**: [StackOverflow Solution](https://stackoverflow.com/a/50770267), [Configure Resources on Docker for Mac](https://docs.docker.com/desktop/mac/#resources)
|
|
|
|
#### Khoj errors out complaining about Tensors mismatch or null
|
|
- **Mitigation**: Disable `image` search using the desktop GUI
|