From 85d627ceb07c85f103006c3e86045023cac1f126 Mon Sep 17 00:00:00 2001 From: Debanjum Date: Sat, 29 Mar 2025 19:04:56 +0530 Subject: [PATCH] Simplify docs to self-host with pip since can use embedded DB now Remove postgres setup instructions from self host with pip docs. It is unnecessary if embedded postgres DB works on the operating system. --- documentation/docs/get-started/setup.mdx | 72 +++++------------------- 1 file changed, 13 insertions(+), 59 deletions(-) diff --git a/documentation/docs/get-started/setup.mdx b/documentation/docs/get-started/setup.mdx index fb8e9f4c..2295f06d 100644 --- a/documentation/docs/get-started/setup.mdx +++ b/documentation/docs/get-started/setup.mdx @@ -115,53 +115,7 @@ Your setup is complete once you see `🌖 Khoj is ready to use` in the server lo -

1. Install Postgres (with PgVector)

- -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. - - - -Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies. - - - For detailed instructions and troubleshooting, see [this section](/contributing/development#2-postgres-installation--setup). - 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. - - - From [official instructions](https://wiki.postgresql.org/wiki/Apt) - - - 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. - - - -

2. Create the Khoj database

- - - - ```shell - createdb khoj -U postgres --password - ``` - - - ```shell - createdb -U postgres khoj --password - ``` - - - ```shell - sudo -u postgres createdb khoj --password - ``` - - - -:::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. -::: - -

3. Install Khoj Server

+

1. Install Khoj Server

- Make sure [python](https://realpython.com/installing-python/) and [pip](https://pip.pypa.io/en/stable/installation/) are installed on your machine - 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 @@ -172,12 +126,12 @@ Run the following command in your terminal to install the Khoj server. ```shell -CMAKE_ARGS="-DGGML_METAL=on" python -m pip install khoj +CMAKE_ARGS="-DGGML_METAL=on" python -m pip install 'khoj[local]' ``` ```shell -python -m pip install khoj +python -m pip install 'khoj[local]' ``` @@ -188,7 +142,7 @@ python -m pip install khoj ```shell # Install Khoj - py -m pip install khoj + py -m pip install 'khoj[local]' ``` @@ -196,7 +150,7 @@ python -m pip install khoj # 1. To use NVIDIA (CUDA) GPU $env:CMAKE_ARGS = "-DGGML_CUDA=on" # 2. Install Khoj - py -m pip install khoj + py -m pip install 'khoj[local]' ``` @@ -204,7 +158,7 @@ python -m pip install khoj # 1. To use AMD (ROCm) GPU $env:CMAKE_ARGS = "-DGGML_HIPBLAS=on" # 2. Install Khoj - py -m pip install khoj + py -m pip install 'khoj[local]' ``` @@ -212,7 +166,7 @@ python -m pip install khoj # 1. To use VULCAN GPU $env:CMAKE_ARGS = "-DGGML_VULKAN=on" # 2. Install Khoj - py -m pip install khoj + py -m pip install 'khoj[local]' ``` @@ -221,34 +175,34 @@ python -m pip install khoj ```shell - python -m pip install khoj + python -m pip install 'khoj[local]' ``` ```shell - CMAKE_ARGS="-DGGML_CUDA=on" FORCE_CMAKE=1 python -m pip install khoj + CMAKE_ARGS="-DGGML_CUDA=on" FORCE_CMAKE=1 python -m pip install 'khoj[local]' ``` ```shell - CMAKE_ARGS="-DGGML_HIPBLAS=on" FORCE_CMAKE=1 python -m pip install khoj + CMAKE_ARGS="-DGGML_HIPBLAS=on" FORCE_CMAKE=1 python -m pip install 'khoj[local]' ``` ```shell - CMAKE_ARGS="-DGGML_VULKAN=on" FORCE_CMAKE=1 python -m pip install khoj + CMAKE_ARGS="-DGGML_VULKAN=on" FORCE_CMAKE=1 python -m pip install 'khoj[local]' ``` -

4. Start Khoj Server

+

2. Start Khoj Server

Run the following command from your terminal to start the Khoj service. ```shell -khoj --anonymous-mode +USE_EMBEDDED_DB="true" khoj --anonymous-mode ``` `--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).