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 details to run, configure Khoj via Web in Readme

Browse source
This commit is contained in:
Debanjum Singh Solanky 2023-07-10 11:54:57 -07:00
parent 20cb314171
commit f4cef377ca
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -125,6 +125,8 @@ These are the general setup instructions for Khoj.
Its simpler as it can skip the *configure* step below. Its simpler as it can skip the *configure* step below.
### 1. Install ### 1. Install
Run the following command in your terminal to install the Khoj backend.
- On Linux/MacOS - On Linux/MacOS
```shell ```shell
python -m pip install khoj-assistant python -m pip install khoj-assistant
@ -137,19 +139,21 @@ These are the general setup instructions for Khoj.
### 2. Run ### 2. Run
Run the following commmand from your terminal to start the Khoj backend and open Khoj in your browser.
```shell ```shell
khoj khoj --gui
``` ```
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`) 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`)
### 3. Configure ### 3. Configure
1. Set `File`, `Folder` and hit `Save` in each Plugins you want to enable for Search on the Khoj config page
1. Enable content types and point to files to search in the First Run Screen that pops up on app start 2. Add your OpenAI API key to Chat Feature settings if you want to use Chat
2. Click `Configure` and wait. The app will download ML models and index the content for search 3. Click `Configure` and wait. The app will download ML models and index the content for search and (optionally) chat
### 4. Install Interface Plugins ### 4. Install Interface Plugins
Khoj exposes a web interface by default.<br /> Khoj exposes a web interface to search, chat and configure by default.<br />
The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs. The optional steps below allow using Khoj from within an existing application like Obsidian or Emacs.
- **Khoj Obsidian**:<br /> - **Khoj Obsidian**:<br />