sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2025-02-20 06:55:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Document using venv to handle dependency conflict on khoj pip install

Browse source 
Resolves #276
This commit is contained in:
Debanjum Singh Solanky 2024-02-21 19:11:23 +05:30
parent 7271164256
commit 57dce91c91
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
documentation/docs/get-started/setup.mdx
View file

@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem';
``` ```
## Setup ## Setup
These are the general setup instructions for Khoj. These are the general setup instructions for self-hosted Khoj.
- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine - 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](/clients/emacs#setup) to setup Khoj with Emacs<br /> - Check the [Khoj Emacs docs](/clients/emacs#setup) to setup Khoj with Emacs<br />
@ -23,7 +23,7 @@ These are the general setup instructions for Khoj.
- Check the [Khoj Obsidian docs](/clients/obsidian#setup) to setup Khoj with Obsidian<br /> - Check the [Khoj Obsidian docs](/clients/obsidian#setup) to setup Khoj with Obsidian<br />
Its simpler as it can skip the *configure* step below. Its simpler as it can skip the *configure* step below.
For Installation, you can either use Docker or install Khoj locally. For Installation, you can either use Docker or install the Khoj server locally.
### Installation Option 1 (Docker) ### Installation Option 1 (Docker)
@ -267,6 +267,18 @@ You can head to http://localhost:42110 to use the web interface. You can also us
## Troubleshoot ## Troubleshoot
#### Dependency conflict when trying to install Khoj python package with pip
- **Reason**: When conflicting dependency versions are required by Khoj vs other python packages installed on your system
- **Fix**: Install Khoj in a python virtual environment using [venv](https://docs.python.org/3/library/venv.html) or [pipx](https://pypa.github.io/pipx) to avoid this dependency conflicts
- **Process**:
1. Install [pipx](https://pypa.github.io/pipx/#install-pipx)
2. Use `pipx` to install Khoj to avoid dependency conflicts with other python packages.
```shell
pipx install khoj-assistant
```
3. Now start `khoj` using the standard steps described earlier
#### Install fails while building Tokenizer dependency #### Install fails while building Tokenizer dependency
- **Details**: `pip install khoj-assistant` fails while building the `tokenizers` dependency. Complains about Rust. - **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: - **Fix**: Install Rust to build the tokenizers package. For example on Mac run: