From 5dea9ef32313d0c4e740e7d7eda71bca3be55a2f Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Fri, 6 Sep 2024 13:20:45 -0700 Subject: [PATCH] Add selected OS tab to url in documentation to ease link sharing --- .../docs/contributing/development.mdx | 18 +++++++------- documentation/docs/get-started/setup.mdx | 24 +++++++++---------- 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/documentation/docs/contributing/development.mdx b/documentation/docs/contributing/development.mdx index 424b2e67..ca492067 100644 --- a/documentation/docs/contributing/development.mdx +++ b/documentation/docs/contributing/development.mdx @@ -20,7 +20,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` - + ```shell # Get Khoj Code @@ -33,7 +33,7 @@ python3 -m venv .venv && source .venv/bin/activate pip install -e '.[dev]' ``` - + ```shell # Get Khoj Code git clone https://github.com/khoj-ai/khoj && cd khoj @@ -45,7 +45,7 @@ python3 -m venv .venv && .venv\Scripts\activate pip install -e '.[dev]' ``` - + ```shell # Get Khoj Code git clone https://github.com/khoj-ai/khoj && cd khoj @@ -63,15 +63,15 @@ pip install -e '.[dev]' Khoj uses the `pgvector` package to store embeddings of your index in a Postgres database. To use this, you need to have Postgres installed. - + Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies. - + 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. Refer to Windows Installation Notes below if there are errors. - + From [official instructions](https://wiki.postgresql.org/wiki/Apt) @@ -84,18 +84,18 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with Make sure to update your environment variables to match your Postgres configuration if you're using a different name. The default values should work for most people. When prompted for a password, you can use the default password `postgres`, or configure it to your preference. Make sure to set the environment variable `POSTGRES_PASSWORD` to the same value as the password you set here. - + ```shell createdb khoj -U postgres --password ``` - + ```shell createdb -U postgres khoj --password ``` - + ```shell sudo -u postgres createdb khoj --password ``` diff --git a/documentation/docs/get-started/setup.mdx b/documentation/docs/get-started/setup.mdx index 653d57cd..8d1493fb 100644 --- a/documentation/docs/get-started/setup.mdx +++ b/documentation/docs/get-started/setup.mdx @@ -48,16 +48,16 @@ Khoj should now be running at http://localhost:42110! You can see the web UI in 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) @@ -70,18 +70,18 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with Make sure to update your environment variables to match your Postgres configuration if you're using a different name. The default values should work for most people. When prompted for a password, you can use the default password `postgres`, or configure it to your preference. Make sure to set the environment variable `POSTGRES_PASSWORD` to the same value as the password you set here. - + ```shell createdb khoj -U postgres --password ``` - + ```shell createdb -U postgres khoj --password ``` - + ```shell sudo -u postgres createdb khoj --password ``` @@ -96,7 +96,7 @@ sudo -u postgres createdb khoj --password Run the following command in your terminal to install the Khoj server. - + ```shell # ARM/M1+ Machines @@ -106,7 +106,7 @@ MAKE_ARGS="-DLLAMA_METAL=on" python -m pip install khoj python -m pip install khoj ``` - + In PowerShell on Windows ```shell # 1. (Optional) To use NVIDIA (CUDA) GPU @@ -120,7 +120,7 @@ python -m pip install khoj py -m pip install khoj ``` - + ```shell # CPU python -m pip install khoj @@ -138,21 +138,21 @@ python -m pip install khoj Before getting started, configure the following environment variables in your terminal for the first run - + ```shell export KHOJ_ADMIN_EMAIL= export KHOJ_ADMIN_PASSWORD= ``` - + If you're using PowerShell: ```shell $env:KHOJ_ADMIN_EMAIL="" $env:KHOJ_ADMIN_PASSWORD="" ``` - + ```shell export KHOJ_ADMIN_EMAIL= export KHOJ_ADMIN_PASSWORD=