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

Add basic instructions for setting up the Khoj desktop interface

Browse source
This commit is contained in:
sabaimran 2023-09-25 21:08:14 -07:00
parent 5e16074b92
commit 99995b2497
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/setup.md
View file

@ -9,7 +9,7 @@ These are the general setup instructions for Khoj.
### 1. Install
#### 1.1 Local Setup
#### 1.1 Local Server Setup
Run the following command in your terminal to install the Khoj backend.
- On Linux/MacOS
@ -24,7 +24,7 @@ Run the following command in your terminal to install the Khoj backend.
For more detailed Windows installation and troubleshooting, see [Windows Install](./windows_install.md).
##### 1.1.1 Start
##### 1.1.1 Local Server Start
Run the following command from your terminal to start the Khoj backend and open Khoj in your browser.
@ -36,7 +36,7 @@ Khoj should now be running at http://localhost:42110. You can see the web UI in
Note: 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`)
#### 1.2 Docker Setup
#### 1.2 Local Docker Setup
Use the sample docker-compose [in Github](https://github.com/khoj-ai/khoj/blob/master/docker-compose.yml) to run Khoj in Docker. To start the container, run the following command in the same directory as the docker-compose.yml file. You'll have to configure the mounted directories to match your local knowledge base.
```shell
@ -45,6 +45,12 @@ docker-compose up
Khoj should now be running at http://localhost:42110. You can see the web UI in your browser.
### 1.2 Setup the frontend [Optional]
This part is currently optional, but may make setup and configuration slightly easier. It removes the need for setting up custom file paths for your Khoj data configurations. Instead, you can simply select the folders or files, and they'll be automatically uploaded to the server. Once you specify a file or file path, you don't need to update the configuration again; it will grab any data diffs dynamically over time.
**To download, go to https://download.khoj.dev** and the correct executable for your OS will automatically start downloading. Once downloaded, you can configure your folders for indexing using the settings tab. To set your chat configuration, you'll have to use the web interface for the Khoj server you setup in the previous step.
### 2. Configure
1. Set `File`, `Folder` and hit `Save` in each Plugins you want to enable for Search on the Khoj config page
2. Add your OpenAI API key to Chat Feature settings if you want to use Chat