sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-12-18 18:47:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 23
khoj/documentation/docs/get-started/setup.mdx

492 lines
23 KiB
Text
Raw Normal View History

Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
---
sidebar_position: 1
---
# Self-Host
Learn about how to self-host Khoj on your own machine.
Include info about privacy in the docs (#631) * Add a page about privacy and organize some of the documentation * Add notice about telemetry * Improve copy for privacy section, link to telemetry section
2024-01-29 12:17:23 +00:00
Benefits to self-hosting:
1. **Privacy**: Your data will never have to leave your private network. You can even use Khoj without an internet connection if deployed on your personal computer.
2. **Customization**: You can customize Khoj to your liking, from models, to host URL, to feature enablement.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```mdx-code-block
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
## Setup Khoj
Document using venv to handle dependency conflict on khoj pip install Resolves #276
2024-02-21 13:41:23 +00:00
These are the general setup instructions for self-hosted Khoj.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
You can install the Khoj server using either [Docker](?server=docker) or [Pip](?server=pip).
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Add more demo videos, images, add feature sections
2024-03-30 09:18:46 +00:00
:::info[Offline Model + GPU]
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
To use the offline chat model with your GPU, we recommend using the Docker setup with Ollama . You can also use the local Khoj setup via the Python package directly.
:::
:::info[First Run]
Restart your Khoj server after the first run to ensure all settings are applied correctly.
Add more demo videos, images, add feature sections
2024-03-30 09:18:46 +00:00
:::
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<Tabs groupId="server" queryString>
<TabItem value="docker" label="Docker">
<Tabs groupId="operating-systems" queryString="os">
<TabItem value="macos" label="MacOS">
<h3>Prerequisites</h3>
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
<h4>Docker</h4>
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
- *Option 1*: Click here to install [Docker Desktop](https://docs.docker.com/desktop/install/mac-install/). Make sure you also install the [Docker Compose](https://docs.docker.com/desktop/install/mac-install/) tool.
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
- *Option 2*: Use [Homebrew](https://brew.sh/) to install Docker and Docker Compose.
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
```shell
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
brew install --cask docker
brew install docker-compose
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
```
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
<h3>Setup</h3>
1. Download the Khoj docker-compose.yml file [from Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml)
```shell
mkdir ~/.khoj && cd ~/.khoj
wget https://raw.githubusercontent.com/khoj-ai/khoj/master/docker-compose.yml
```
2. Configure the environment variables in the `docker-compose.yml`
- Set `KHOJ_ADMIN_PASSWORD`, `KHOJ_DJANGO_SECRET_KEY` (and optionally the `KHOJ_ADMIN_EMAIL`) to something secure. This allows you to customize Khoj later via the admin panel.
- Set `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, or `GEMINI_API_KEY` to your API key if you want to use OpenAI, Anthropic or Gemini commercial chat models respectively.
- Uncomment `OPENAI_API_BASE` to use [Ollama](/advanced/ollama?type=first-run&server=docker#setup) running on your host machine. Or set it to the URL of your OpenAI compatible API like vLLM or [LMStudio](/advanced/lmstudio).
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
3. Start Khoj by running the following command in the same directory as your docker-compose.yml file.
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
```shell
cd ~/.khoj
docker-compose up
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
<TabItem value="windows" label="Windows">
<h3>Prerequisites</h3>
1. Install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install) and restart your machine
```shell
# Run in PowerShell
wsl --install
```
2. Install [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/) with **[WSL2 backend](https://docs.docker.com/desktop/wsl/#turn-on-docker-desktop-wsl-2)** (default)
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
<h3>Setup</h3>
1. Download the Khoj docker-compose.yml file [from Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml)
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
```shell
# Windows users should use their WSL2 terminal to run these commands
mkdir ~/.khoj && cd ~/.khoj
wget https://raw.githubusercontent.com/khoj-ai/khoj/master/docker-compose.yml
```
2. Configure the environment variables in the `docker-compose.yml`
- Set `KHOJ_ADMIN_PASSWORD`, `KHOJ_DJANGO_SECRET_KEY` (and optionally the `KHOJ_ADMIN_EMAIL`) to something secure. This allows you to customize Khoj later via the admin panel.
- Set `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, or `GEMINI_API_KEY` to your API key if you want to use OpenAI, Anthropic or Gemini commercial chat models respectively.
- Uncomment `OPENAI_API_BASE` to use [Ollama](/advanced/ollama) running on your host machine. Or set it to the URL of your OpenAI compatible API like vLLM or [LMStudio](/advanced/lmstudio).
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
3. Start Khoj by running the following command in the same directory as your docker-compose.yml file.
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
```shell
# Windows users should use their WSL2 terminal to run these commands
cd ~/.khoj
docker-compose up
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
<TabItem value="linux" label="Linux">
<h3>Prerequisites</h3>
Fix Docker desktop link for Linux
2024-10-23 18:24:54 +00:00
Install [Docker Desktop](https://docs.docker.com/desktop/install/linux/).
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
You can also use your package manager to install Docker Engine & Docker Compose.
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
<h3>Setup</h3>
1. Download the Khoj docker-compose.yml file [from Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml)
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
```shell
mkdir ~/.khoj && cd ~/.khoj
wget https://raw.githubusercontent.com/khoj-ai/khoj/master/docker-compose.yml
```
2. Configure the environment variables in the `docker-compose.yml`
- Set `KHOJ_ADMIN_PASSWORD`, `KHOJ_DJANGO_SECRET_KEY` (and optionally the `KHOJ_ADMIN_EMAIL`) to something secure. This allows you to customize Khoj later via the admin panel.
- Set `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, or `GEMINI_API_KEY` to your API key if you want to use OpenAI, Anthropic or Gemini commercial chat models respectively.
- Uncomment `OPENAI_API_BASE` to use [Ollama](/advanced/ollama) running on your host machine. Or set it to the URL of your OpenAI compatible API like vLLM or [LMStudio](/advanced/lmstudio).
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
3. Start Khoj by running the following command in the same directory as your docker-compose.yml file.
Simplify integrating Ollama, OpenAI proxies with Khoj on first run - Integrate with Ollama or other openai compatible APIs by simply setting `OPENAI_API_BASE' environment variable in docker-compose etc. - Update docs on integrating with Ollama, openai proxies on first run - Auto populate all chat models supported by openai compatible APIs - Auto set vision enabled for all commercial models - Minor - Add huggingface cache to khoj_models volume. This is where chat models and (now) sentence transformer models are stored by default - Reduce verbosity of yarn install of web app. Otherwise hit docker log size limit & stops showing remaining logs after web app install - Suggest `ollama pull <model_name>` to start it in background
2024-11-17 07:53:11 +00:00
```shell
cd ~/.khoj
docker-compose up
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
</Tabs>
Add optional brew steps for docker install
2024-10-31 19:41:53 +00:00
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::info[Remote Access]
By default Khoj is only accessible on the machine it is running. To access Khoj from a remote machine see [Remote Access Docs](/advanced/remote).
:::
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Your setup is complete once you see `🌖 Khoj is ready to use` in the server logs on your terminal.
</TabItem>
<TabItem value="pip" label="Pip">
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h3>1. Install Postgres (with PgVector)</h3>
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Khoj uses Postgres DB for all server configuration and to scale to multi-user setups. It uses the pgvector package in Postgres to manage your document embeddings. Both Postgres and pgvector need to be installed for Khoj to work.
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<Tabs groupId="operating-systems" queryString="os">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
<TabItem value="macos" label="MacOS">
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<TabItem value="windows" label="Windows">
Provide more context in docs for self-hosting Khoj on Windows
2024-05-28 15:25:06 +00:00
For detailed instructions and troubleshooting, see [this section](/contributing/development#2-postgres-installation--setup).
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
1. Use the [recommended installer](https://www.postgresql.org/download/windows/).
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#windows) in case you need to manually install it. Windows support is experimental for pgvector currently, so we recommend using Docker.
</TabItem>
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<TabItem value="linux" label="Linux">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
From [official instructions](https://wiki.postgresql.org/wiki/Apt)
</TabItem>
<TabItem value="source" label="From Source">
1. Follow instructions to [Install Postgres](https://www.postgresql.org/download/)
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it.
</TabItem>
</Tabs>
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h3>2. Create the Khoj database</h3>
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<Tabs groupId="operating-systems" queryString="os">
<TabItem value="macos" label="MacOS">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
createdb khoj -U postgres --password
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
<TabItem value="windows" label="Windows">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
createdb -U postgres khoj --password
```
</TabItem>
<TabItem value="linux" label="Linux">
```shell
sudo -u postgres createdb khoj --password
```
</TabItem>
</Tabs>
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::info[Postgres Env Config]
Make sure to update the `POSTGRES_HOST`, `POSTGRES_PORT`, `POSTGRES_USER`, `POSTGRES_DB` or `POSTGRES_PASSWORD` environment variables to match any customizations in your Postgres configuration.
:::
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h3>3. Install Khoj Server</h3>
- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine
Fix link to llama-cpp-python setup docs
2024-10-09 08:30:33 +00:00
- Check [llama-cpp-python setup](https://github.com/abetlen/llama-cpp-python?tab=readme-ov-file#supported-backends) if you hit any llama-cpp issues with the installation
Improve docker builds for local hosting (#476) * Remove GPT4All dependency in pyproject.toml and use multiplatform builds in the dockerization setup in GH actions * Move configure_search method into indexer * Add conditional installation for gpt4all * Add hint to go to localhost:42110 in the docs. Addresses #477
2023-09-09 00:07:26 +00:00
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Run the following command in your terminal to install the Khoj server.
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<Tabs groupId="operating-systems" queryString="os">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
<TabItem value="macos" label="MacOS">
Update Documentation with flags to enable GPU on Khoj pip install - Use tabs for GPU/CPU type khoj being install on - Update CMAKE flags to use to install Khoj with correct GPU support Previous flags used DLLAMA, this has been updated to use DGGML now in llama.cpp
2024-09-29 10:33:05 +00:00
<Tabs groupId="gpu" queryString="gpu">
<TabItem value="arm" label="ARM/M1+">
```shell
CMAKE_ARGS="-DGGML_METAL=on" python -m pip install khoj
```
</TabItem>
<TabItem value="intel" label="Intel">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
python -m pip install khoj
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```
Update Documentation with flags to enable GPU on Khoj pip install - Use tabs for GPU/CPU type khoj being install on - Update CMAKE flags to use to install Khoj with correct GPU support Previous flags used DLLAMA, this has been updated to use DGGML now in llama.cpp
2024-09-29 10:33:05 +00:00
</TabItem>
</Tabs>
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<TabItem value="windows" label="Windows">
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Run the following command in PowerShell on Windows
Update Documentation with flags to enable GPU on Khoj pip install - Use tabs for GPU/CPU type khoj being install on - Update CMAKE flags to use to install Khoj with correct GPU support Previous flags used DLLAMA, this has been updated to use DGGML now in llama.cpp
2024-09-29 10:33:05 +00:00
<Tabs groupId="gpu" queryString="gpu">
<TabItem value="cpu" label="CPU">
```shell
# Install Khoj
py -m pip install khoj
```
</TabItem>
<TabItem value="nvidia" label="NVIDIA (CUDA) GPU">
```shell
# 1. To use NVIDIA (CUDA) GPU
$env:CMAKE_ARGS = "-DGGML_CUDA=on"
Update docs to show how to setup llama-cpp with Khoj - How to pip install khoj to run offline chat on GPU After migration to llama-cpp-python more GPU types are supported but require build step so mention how - New default offline chat model - Where to get supported chat models from on HuggingFace
2024-03-15 22:55:14 +00:00
# 2. Install Khoj
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
py -m pip install khoj
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```
Update Documentation with flags to enable GPU on Khoj pip install - Use tabs for GPU/CPU type khoj being install on - Update CMAKE flags to use to install Khoj with correct GPU support Previous flags used DLLAMA, this has been updated to use DGGML now in llama.cpp
2024-09-29 10:33:05 +00:00
</TabItem>
<TabItem value="amd" label="AMD (ROCm) GPU">
```shell
# 1. To use AMD (ROCm) GPU
$env:CMAKE_ARGS = "-DGGML_HIPBLAS=on"
# 2. Install Khoj
py -m pip install khoj
```
</TabItem>
<TabItem value="vulkan" label="VULKAN GPU">
```shell
# 1. To use VULCAN GPU
$env:CMAKE_ARGS = "-DGGML_VULKAN=on"
# 2. Install Khoj
py -m pip install khoj
```
</TabItem>
</Tabs>
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
Add selected OS tab to url in documentation to ease link sharing
2024-09-06 20:20:45 +00:00
<TabItem value="linux" label="Linux">
Update Documentation with flags to enable GPU on Khoj pip install - Use tabs for GPU/CPU type khoj being install on - Update CMAKE flags to use to install Khoj with correct GPU support Previous flags used DLLAMA, this has been updated to use DGGML now in llama.cpp
2024-09-29 10:33:05 +00:00
<Tabs groupId="gpu" queryString="gpu">
<TabItem value="cpu" label="CPU">
```shell
python -m pip install khoj
```
</TabItem>
<TabItem value="nvidia" label="NVIDIA (CUDA) GPU">
```shell
CMAKE_ARGS="-DGGML_CUDA=on" FORCE_CMAKE=1 python -m pip install khoj
```
</TabItem>
<TabItem value="amd" label="AMD (ROCm) GPU">
```shell
CMAKE_ARGS="-DGGML_HIPBLAS=on" FORCE_CMAKE=1 python -m pip install khoj
```
</TabItem>
<TabItem value="vulkan" label="VULKAN GPU">
```shell
CMAKE_ARGS="-DGGML_VULKAN=on" FORCE_CMAKE=1 python -m pip install khoj
```
</TabItem>
</Tabs>
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
</Tabs>
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h3>4. Start Khoj Server</h3>
Set a default value for the khoj django secret key and add additional guidance for setting environment variables on first run
2023-11-28 17:39:44 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Run the following command from your terminal to start the Khoj service.
Improve docker builds for local hosting (#476) * Remove GPT4All dependency in pyproject.toml and use multiplatform builds in the dockerization setup in GH actions * Move configure_search method into indexer * Add conditional installation for gpt4all * Add hint to go to localhost:42110 in the docs. Addresses #477
2023-09-09 00:07:26 +00:00
```shell
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
khoj --anonymous-mode
Improve docker builds for local hosting (#476) * Remove GPT4All dependency in pyproject.toml and use multiplatform builds in the dockerization setup in GH actions * Move configure_search method into indexer * Add conditional installation for gpt4all * Add hint to go to localhost:42110 in the docs. Addresses #477
2023-09-09 00:07:26 +00:00
```
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
`--anonymous-mode` allows access to Khoj without requiring login. This is usually fine for local only, single user setups. If you need authentication follow the [authentication setup docs](/advanced/authentication).
Improve docker builds for local hosting (#476) * Remove GPT4All dependency in pyproject.toml and use multiplatform builds in the dockerization setup in GH actions * Move configure_search method into indexer * Add conditional installation for gpt4all * Add hint to go to localhost:42110 in the docs. Addresses #477
2023-09-09 00:07:26 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h4>First Run</h4>
On the first run of the above command, you will be prompted to:
1. Create an admin account with a email and secure password
2. Customize the chat models to enable
- Keep your [OpenAI](https://platform.openai.com/api-keys), [Anthropic](https://console.anthropic.com/account/keys), [Gemini](https://aistudio.google.com/app/apikey) API keys and [OpenAI](https://platform.openai.com/docs/models), [Anthropic](https://docs.anthropic.com/en/docs/about-claude/models#model-names), [Gemini](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#gemini-models), [Offline](https://huggingface.co/models?pipeline_tag=text-generation&library=gguf) chat model names handy to set any of them up during first run.
3. Your setup is complete once you see `🌖 Khoj is ready to use` in the server logs on your terminal!
Improve docker builds for local hosting (#476) * Remove GPT4All dependency in pyproject.toml and use multiplatform builds in the dockerization setup in GH actions * Move configure_search method into indexer * Add conditional installation for gpt4all * Add hint to go to localhost:42110 in the docs. Addresses #477
2023-09-09 00:07:26 +00:00
Add basic instructions for setting up the Khoj desktop interface
2023-09-26 04:08:14 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::tip[Auto Start]
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`)
:::
</TabItem>
</Tabs>
Add basic instructions for setting up the Khoj desktop interface
2023-09-26 04:08:14 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
## Use Khoj
Deprecate desktop build instructions from old setup
2023-09-26 05:02:02 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
You can now open the web app at http://localhost:42110 and start interacting!<br />
Nothing else is necessary, but you can customize your setup further by following the steps below.
:::info[First Message to Offline Chat Model]
The offline chat model gets downloaded when you first send a message to it. The download can take a few minutes! Subsequent messages should be faster.
:::
### Add Chat Models
<h4>Login to the Khoj Admin Panel</h4>
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Go to http://localhost:42110/server/admin and login with the admin credentials you setup during installation.
Deprecate desktop build instructions from old setup
2023-09-26 05:02:02 +00:00
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
:::info[CSRF Error]
Ensure you are using **localhost, not 127.0.0.1**, to access the admin panel to avoid the CSRF error.
:::
Deprecate desktop build instructions from old setup
2023-09-26 05:02:02 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::info[DISALLOWED HOST or Bad Request (400) Error]
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
You may hit this if you try access Khoj exposed on a custom domain (e.g. 192.168.12.3 or example.com) or over HTTP.
Fix typo in docs for error 400 fix when self-hosting (#938)
2024-10-17 06:15:43 +00:00
Set the environment variables KHOJ_DOMAIN=your-domain and KHOJ_NO_HTTPS=True if required to avoid this error.
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
:::
Fix access to Khoj admin panel from non HTTPS custom domains To access the Khoj admin panel from a non HTTPS custom domain the `KHOJ_NO_SSL' and `KHOJ_DOMAIN' env vars need to be explictly set. See the updated setup docs for details. Resolves #662
2024-04-16 21:27:30 +00:00
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
:::tip[Note]
Using Safari on Mac? You might not be able to login to the admin panel. Try using Chrome or Firefox instead.
Add an agents feature page, and clarification around custom domains
2024-03-30 08:50:46 +00:00
:::
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<h4>Configure Chat Model</h4>
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Setup which chat model you'd want to use. Khoj supports local and online chat models.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
<Tabs groupId="chatmodel" queryString>
<TabItem value="openai" label="OpenAI">
Move some gifs to the assets s3 bucket and add instructions for Ollama, shareable conversations
2024-05-24 19:38:20 +00:00
:::info[Ollama Integration]
Fix a variety of links
2024-07-08 11:19:13 +00:00
Using Ollama? See the [Ollama Integration](/advanced/ollama) section for more custom setup instructions.
Move some gifs to the assets s3 bucket and add instructions for Ollama, shareable conversations
2024-05-24 19:38:20 +00:00
:::
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
1. Create a new [AI Model Api](http://localhost:42110/server/admin/database/aimodelapi/add) in the server admin settings.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Add your [OpenAI API key](https://platform.openai.com/api-keys)
- Give the configuration a friendly name like `OpenAI`
Fix list references in use openai proxy docs
2024-10-01 06:21:33 +00:00
- (Optional) Set the API base URL. It is only relevant if you're using another OpenAI-compatible proxy server like [Ollama](/advanced/ollama) or [LMStudio](/advanced/lmstudio).<br />
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
![example configuration for ai model api](/img/example_openai_processor_config.png)
Rename Chat Model Options table to Chat Model as short & readable (#1003) - Previous was incorrectly plural but was defining only a single model - Rename chat model table field to name - Update documentation - Update references functions and variables to match new name
2024-12-12 19:24:16 +00:00
2. Create a new [chat model](http://localhost:42110/server/admin/database/chatmodel/add)
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Set the `chat-model` field to an [OpenAI chat model](https://platform.openai.com/docs/models). Example: `gpt-4o`.
Add and update documentation for setting up khoj with an openai proxy server or offline llm
2024-04-27 14:46:32 +00:00
- Make sure to set the `model-type` field to `OpenAI`.
Update the documentation with swanky new demo videos
2024-09-12 02:57:01 +00:00
- If your model supports vision, set the `vision enabled` field to `true`. This is currently only supported for OpenAI models with vision capabilities.
Fix list references in use openai proxy docs
2024-10-01 06:21:33 +00:00
- The `tokenizer` and `max-prompt-size` fields are optional. Set them only if you're sure of the tokenizer or token limit for the model you're using. Contact us if you're unsure what to do here.<br />
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
![example configuration for chat model options](/img/example_chatmodel_option.png)
</TabItem>
<TabItem value="anthropic" label="Anthropic">
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
1. Create a new [AI Model API](http://localhost:42110/server/admin/database/aimodelapi/add) in the server admin settings.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Add your [Anthropic API key](https://console.anthropic.com/account/keys)
- Give the configuration a friendly name like `Anthropic`. Do not configure the API base url.
Rename Chat Model Options table to Chat Model as short & readable (#1003) - Previous was incorrectly plural but was defining only a single model - Rename chat model table field to name - Update documentation - Update references functions and variables to match new name
2024-12-12 19:24:16 +00:00
2. Create a new [chat model](http://localhost:42110/server/admin/database/chatmodel/add)
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Set the `chat-model` field to an [Anthropic chat model](https://docs.anthropic.com/en/docs/about-claude/models#model-names). Example: `claude-3-5-sonnet-20240620`.
- Set the `model-type` field to `Anthropic`.
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
- Set the `ai model api` field to the Anthropic AI Model API you created in step 1.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
<TabItem value="gemini" label="Gemini">
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
1. Create a new [AI Model API](http://localhost:42110/server/admin/database/aimodelapi/add) in the server admin settings.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Add your [Gemini API key](https://aistudio.google.com/app/apikey)
- Give the configuration a friendly name like `Gemini`. Do not configure the API base url.
Rename Chat Model Options table to Chat Model as short & readable (#1003) - Previous was incorrectly plural but was defining only a single model - Rename chat model table field to name - Update documentation - Update references functions and variables to match new name
2024-12-12 19:24:16 +00:00
2. Create a new [chat model](http://localhost:42110/server/admin/database/chatmodel/add)
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- Set the `chat-model` field to a [Google Gemini chat model](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#gemini-models). Example: `gemini-1.5-flash`.
- Set the `model-type` field to `Gemini`.
Rename OpenAIProcessorConversationConfig DB model to more apt AiModelApi (#998) * Rename OpenAIProcessorConversationConfig to more apt AiModelAPI The DB model name had drifted from what it is being used for, a general chat api provider that supports other chat api providers like anthropic and google chat models apart from openai based chat models. This change renames the DB model and updates the docs to remove this confusion. Using Ai Model Api we catch most use-cases including chat, stt, image generation etc.
2024-12-09 02:02:29 +00:00
- Set the `ai model api` field to the Gemini AI Model API you created in step 1.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</TabItem>
<TabItem value="offline" label="Offline">
Offline chat stays completely private and can work without internet using any open-weights model.
:::tip[System Requirements]
Update the documentation with swanky new demo videos
2024-09-12 02:57:01 +00:00
- Minimum 8 GB RAM. Recommend **16Gb VRAM**
- Minimum **5 GB of Disk** available
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- A Nvidia, AMD GPU or a Mac M1+ machine would significantly speed up chat responses
:::
Add documentation for local setup and fix admin panel bugs - Wasn't able to login to the admin panel when KHOJ_DEBUG was not True. Fix this error so self-hosted users can get unblocked from accessing the admin settings - Don't force users to set their KHOJ_DJANGO_SECRET_KEY
2023-12-01 01:55:17 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
1. Get the name of your preferred chat model from [HuggingFace](https://huggingface.co/models?pipeline_tag=text-generation&library=gguf). *Most GGUF format chat models are supported*.
Rename Chat Model Options table to Chat Model as short & readable (#1003) - Previous was incorrectly plural but was defining only a single model - Rename chat model table field to name - Update documentation - Update references functions and variables to match new name
2024-12-12 19:24:16 +00:00
2. Open the [create chat model page](http://localhost:42110/server/admin/database/chatmodel/add/) on the admin panel
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
3. Set the `chat-model` field to the name of your preferred chat model
- Make sure the `model-type` is set to `Offline`
4. Set the newly added chat model as your preferred model in your [User chat settings](http://localhost:42110/settings) and [Server chat settings](http://localhost:42110/server/admin/database/serverchatsettings/).
5. Restart the Khoj server and [start chatting](http://localhost:42110) with your new offline model!
</TabItem>
</Tabs>
Add an agents feature page, and clarification around custom domains
2024-03-30 08:50:46 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::tip[Multiple Chat Models]
Set your preferred default chat model in the `Default`, `Advanced` fields of your [ServerChatSettings](http://localhost:42110/server/admin/database/serverchatsettings/).
Khoj uses these chat model for all intermediate steps like intent detection, web search etc.
:::
Add an agents feature page, and clarification around custom domains
2024-03-30 08:50:46 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::info[Chat Model Fields]
- The `tokenizer` and `max-prompt-size` fields are optional. Set them only if you're sure of the tokenizer or token limit for the model you're using. This improves context stuffing. Contact us if you're unsure what to do here.
- Only tick the `vision enabled` field for OpenAI models with vision capabilities like gpt-4o. Vision capabilities in other chat models is not currently utilized.
:::
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
### Sync your Knowledge
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
- You can chat with your notes and documents using Khoj.
- Khoj can keep your files and folders synced using the Khoj [Desktop](/clients/desktop#setup), [Obsidian](/clients/obsidian#setup) or [Emacs](/clients/emacs#setup) clients.
- Your [Notion workspace](/data-sources/notion_integration) can be directly synced from the web app.
- You can also just drag and drop specific files you want to chat with on the [Web app](/clients/web#upload-documents).
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
### Setup Khoj Clients
The Khoj web app is available by default to chat, search and configure Khoj.<br />
You can also install a Khoj client to easily access it from Obsidian, Emacs, Whatsapp or your OS and keep your documents synced with Khoj.
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::info[Note]
Add Advanced Self Hosting Section, Improve Self Hosting, OpenAI Proxy Docs - Add instructions for self-hosted users with info, warning boxes to avoid, fix common issues when setting up Khoj server - Create new Advanced Self Hosting section - Extract Advanced Self-Hosting Sections from the Advanced Page and move them to separate Pages under Advanced Self Hosting section - Improve OpenAI Proxy Docs - Put Ollama setup as a section under OpenAI API Proxy page instead of a separate page - Add Section to use Khoj with chat model from LM Studio - Update LiteLLM docs to use chat model from LM Studio
2024-06-24 07:27:11 +00:00
Set the host URL on your clients settings page to your Khoj server URL. By default, use `http://127.0.0.1:42110` or `http://localhost:42110`. Note that `localhost` may not work in all cases.
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
:::
<Tabs groupId="client" queryString>
<TabItem value="desktop" label="Desktop">
- Read the Khoj Desktop app [setup docs](/clients/desktop#setup).
</TabItem>
<TabItem value="emacs" label="Emacs">
- Read the Khoj Emacs package [setup docs](/clients/emacs#setup).
</TabItem>
<TabItem value="obsidian" label="Obsidian">
- Read the Khoj Obsidian plugin [setup docs](/clients/obsidian#setup).
</TabItem>
<TabItem value="whatsapp" label="Whatsapp">
- Read the Khoj Whatsapp app [setup docs](/clients/whatsapp).
</TabItem>
</Tabs>
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
## Upgrade
Update docs to reflect new setup processes and instructions based on rearchitecture - Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally - Add instructiosn for Docker - Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 20:56:42 +00:00
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
### Upgrade Server
<Tabs groupId="server" queryString>
<TabItem value="pip" label="Pip">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
pip install --upgrade khoj
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```
*Note: To upgrade to the latest pre-release version of the khoj server run below command*
</TabItem>
<TabItem value="docker" label="Docker">
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Run the commands below from the same directory where you have your `docker-compose.yml` file.
This will fetch the latest build and upgrade your server.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
# Windows users should use their WSL2 terminal to run these commands
cd ~/.khoj # assuming your khoj docker-compose.yml file is here
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
docker-compose up --build
```
</TabItem>
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</Tabs>
### Upgrade Clients
<Tabs groupId="client" queryString>
<TabItem value="desktop" label="Desktop">
- The Desktop app automatically updates to the latest released version on restart.
- You can manually download the latest version from the [Khoj Website](https://khoj.dev/downloads).
</TabItem>
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
<TabItem value="emacs" label="Emacs">
- Use your Emacs Package Manager to Upgrade
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-07 19:02:23 +00:00
- See [khoj.el package setup](/clients/emacs#setup) for details
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
<TabItem value="obsidian" label="Obsidian">
- Upgrade via the Community plugins tab on the settings pane in the Obsidian app
Make the docs overview page as the main docs landing page - Make the docs overview page available at docs.khoj.dev root instead of under docs.khoj.dev/docs path - Remove the new landing page, it is unnecessary. - Remove /docs path prefix from links to internal doc pages - Remove .md path suffix in internal doc pages for consistency
2024-01-07 19:02:23 +00:00
- See the [khoj plugin setup](/clients/obsidian#setup) for details
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
</Tabs>
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
## Uninstall
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
### Uninstall Server
<Tabs groupId="server" queryString>
<TabItem value="pip" label="Pip">
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
# uninstall khoj server
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
pip uninstall khoj
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
# delete khoj postgres db
dropdb khoj -U postgres
```
</TabItem>
<TabItem value="docker" label="Docker">
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Run the command below from the same directory where you have your `docker-compose` file.
This will remove the server containers, networks, images and volumes.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
```shell
docker-compose down --volumes
```
</TabItem>
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
</Tabs>
### Uninstall Clients
<Tabs groupId="client" queryString>
<TabItem value="desktop" label="Desktop">
Uninstall the Khoj Desktop client in the standard way from your OS.
</TabItem>
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
<TabItem value="emacs" label="Emacs">
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Uninstall the Khoj Emacs package in the standard way from Emacs.
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
<TabItem value="obsidian" label="Obsidian">
Improve Self Hosting Docs. Better Docker, Remote Access Setup Instructions - Improve Self Hosting Docker Instructions - Ask to Install Docker Desktop to not require separate docker-compose install and unify the instruction across OS - To Self Host on Windows, ask to use Docker Desktop with WSL2 backend - Use nested Tab grouping to split Docker vs Pip Self Host Instructions - Reduce Self Host Setup Steps in Documentation after code simplification - First run now avoids need to configure Khoj via admin panel - So move the chat model config steps into optional post setup config section - Improve Instructions to Configure chat models on First Run - Compress configuring chat model providers into a Tab Group - Add Documentation for Remote Access under Advanced Self Hosting
2024-09-21 02:20:24 +00:00
Uninstall via the Community plugins tab on the settings pane in the Obsidian app
Migrate to using docusaurus, rather than docsify for documentation (#603) * Add docusaurus documentation (to replace the docsify setup * Remove older docs * Specify documentation as the gh pages build action working directory
2024-01-07 14:58:15 +00:00
</TabItem>
</Tabs>
Update Uninstall Documentation for Khoj Server when Self Hosting
2024-01-05 18:15:06 +00:00
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
## Troubleshoot
Document using venv to handle dependency conflict on khoj pip install Resolves #276
2024-02-21 13:41:23 +00:00
#### 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
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
pipx install khoj
Document using venv to handle dependency conflict on khoj pip install Resolves #276
2024-02-21 13:41:23 +00:00
```
3. Now start `khoj` using the standard steps described earlier
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
#### Install fails while building Tokenizer dependency
Migrate the pypi package to khoj project name. Update references - Deprecate khoj-assistant pypi package. Use more accurate and succinct pypi project name, khoj - Update references to sye khoj pypi package in docs and code instead of the legacy khoj-assistant pypi package - Update pypi workflow to publish to both khoj, khoj-assistant for now - Update stale python 3.9 support mentioned in our pyproject. Can't support python 3.9 as depend on latest django which support >=3.10
2024-07-16 16:15:41 +00:00
- **Details**: `pip install khoj` fails while building the `tokenizers` dependency. Complains about Rust.
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify
2023-07-21 05:34:25 +00:00
- **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
#### 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)
Reference in a new issue Copy permalink