mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-12-21 03:47:45 +00:00
44 lines
1.6 KiB
Markdown
44 lines
1.6 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Desktop
|
|
|
|
> Upload your knowledge base to Khoj and chat with your whole corpus
|
|
|
|
## Companion App
|
|
|
|
Share your files, folders with Khoj using the app.
|
|
Khoj will keep these files in sync to provide contextual responses when you search or chat.
|
|
|
|
## Setup
|
|
:::info[Self Hosting]
|
|
If you are self-hosting the Khoj server, update the *Settings* page on the Khoj Desktop app to:
|
|
- Set the `Khoj URL` field to your Khoj server URL. By default, use `http://127.0.0.1:42110`.
|
|
- Do not set the `Khoj API Key` field if your Khoj server runs in anonymous mode. For example, `khoj --anonymous-mode`
|
|
:::
|
|
|
|
|
|
1. Install the [Khoj Desktop app](https://khoj.dev/downloads) for your OS
|
|
2. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients)
|
|
3. Set your Khoj API Key on the *Settings* page of the Khoj Desktop app
|
|
4. [Optional] Add any files, folders you'd like Khoj to be aware of on the *Settings* page and Click *Save*.
|
|
These files and folders will be automatically kept in sync for you
|
|
|
|
# Main App
|
|
|
|
You can also install the Khoj application on your desktop as a progressive web app.
|
|
|
|
1. Open the [Khoj Web App](https://app.khoj.dev) in Chrome.
|
|
2. Click on the install button in the address bar to install the app. You must be logged into your Chrome browser for this to work.
|
|
|
|
|
|
|
|
Alternatively, you can also install using this route:
|
|
|
|
1. Open the three-dot menu in the top right corner of the browser.
|
|
2. Go to 'Cast, Save, and Share' option.
|
|
3. Click on the "Open in Khoj" option.
|
|
|
|
|
|
|