mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 23:48:56 +01:00
Update Documentation project dependencies
Stop wrapping Tabs in explicit mdx-code-blocks as build after upgrade throws error
This commit is contained in:
parent
7941b12d50
commit
87c52dfd02
3 changed files with 817 additions and 873 deletions
|
@ -20,7 +20,6 @@ import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
```
|
```
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
```shell
|
```shell
|
||||||
|
@ -59,12 +58,11 @@ pip install -e '.[dev]'
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
#### 2. Postgres Installation & Setup
|
#### 2. Postgres Installation & Setup
|
||||||
|
|
||||||
Khoj uses the `pgvector` package to store embeddings of your index in a Postgres database. To use this, you need to have Postgres installed.
|
Khoj uses the `pgvector` package to store embeddings of your index in a Postgres database. To use this, you need to have Postgres installed.
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
|
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
|
||||||
|
@ -81,13 +79,11 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with
|
||||||
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it.
|
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
##### Create the Khoj database
|
##### Create the Khoj database
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
```shell
|
```shell
|
||||||
|
@ -105,7 +101,6 @@ sudo -u postgres createdb khoj --password
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
#### 3. Run
|
#### 3. Run
|
||||||
1. Start Khoj
|
1. Start Khoj
|
||||||
|
|
|
@ -48,7 +48,6 @@ 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.
|
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.
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
|
Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with `pgvector` and relevant dependencies.
|
||||||
|
@ -66,13 +65,11 @@ Install [Postgres.app](https://postgresapp.com/). This comes pre-installed with
|
||||||
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it.
|
2. Follow instructions to [Install PgVector](https://github.com/pgvector/pgvector#installation) in case you need to manually install it.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
##### Create the Khoj database
|
##### Create the Khoj database
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
```shell
|
```shell
|
||||||
|
@ -90,7 +87,6 @@ sudo -u postgres createdb khoj --password
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
#### Install Khoj server
|
#### Install Khoj server
|
||||||
|
|
||||||
|
@ -100,7 +96,6 @@ sudo -u postgres createdb khoj --password
|
||||||
|
|
||||||
Run the following command in your terminal to install the Khoj server.
|
Run the following command in your terminal to install the Khoj server.
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
```shell
|
```shell
|
||||||
|
@ -138,13 +133,11 @@ python -m pip install khoj
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
##### Start Khoj Server
|
##### Start Khoj Server
|
||||||
|
|
||||||
Before getting started, configure the following environment variables in your terminal for the first run
|
Before getting started, configure the following environment variables in your terminal for the first run
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="operating-systems">
|
<Tabs groupId="operating-systems">
|
||||||
<TabItem value="macos" label="MacOS">
|
<TabItem value="macos" label="MacOS">
|
||||||
```shell
|
```shell
|
||||||
|
@ -166,7 +159,6 @@ Before getting started, configure the following environment variables in your te
|
||||||
```
|
```
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
Run the following command from your terminal to start the Khoj backend and open Khoj in your browser.
|
Run the following command from your terminal to start the Khoj backend and open Khoj in your browser.
|
||||||
|
@ -253,7 +245,6 @@ Set the host URL on your clients settings page to your Khoj server URL. By defau
|
||||||
|
|
||||||
## Upgrade
|
## Upgrade
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="environment">
|
<Tabs groupId="environment">
|
||||||
<TabItem value="localsetup" label="Local Setup">
|
<TabItem value="localsetup" label="Local Setup">
|
||||||
```shell
|
```shell
|
||||||
|
@ -276,11 +267,9 @@ Set the host URL on your clients settings page to your Khoj server URL. By defau
|
||||||
- See the [khoj plugin setup](/clients/obsidian#setup) for details
|
- See the [khoj plugin setup](/clients/obsidian#setup) for details
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
## Uninstall
|
## Uninstall
|
||||||
|
|
||||||
```mdx-code-block
|
|
||||||
<Tabs groupId="environment">
|
<Tabs groupId="environment">
|
||||||
<TabItem value="localsetup" label="Local Setup">
|
<TabItem value="localsetup" label="Local Setup">
|
||||||
```shell
|
```shell
|
||||||
|
@ -307,7 +296,6 @@ Set the host URL on your clients settings page to your Khoj server URL. By defau
|
||||||
You can also `rm -rf ~/.khoj` to remove the Khoj data directory if did a local install.
|
You can also `rm -rf ~/.khoj` to remove the Khoj data directory if did a local install.
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
```
|
|
||||||
|
|
||||||
## Troubleshoot
|
## Troubleshoot
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue