mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-11-23 23:48:56 +01:00
Update client setup docs with instructions for self-hosting users
Resolves #808
This commit is contained in:
parent
dd44933515
commit
d66a0ccfaa
3 changed files with 29 additions and 6 deletions
|
@ -21,11 +21,17 @@ Khoj will keep these files in sync to provide contextual responses when you sear
|
||||||
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
- **Incremental**: Incremental search for a fast, search-as-you-type experience
|
||||||
|
|
||||||
## Setup
|
## 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
|
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)
|
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
|
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*
|
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
|
These files and folders will be automatically kept in sync for you
|
||||||
|
|
||||||
## Interface
|
## Interface
|
||||||
|
|
|
@ -30,6 +30,12 @@ sidebar_position: 2
|
||||||
| ![khoj search on emacs](/img/khoj_search_on_emacs.png) | ![khoj chat on emacs](/img/khoj_chat_on_emacs.png) |
|
| ![khoj search on emacs](/img/khoj_search_on_emacs.png) | ![khoj chat on emacs](/img/khoj_chat_on_emacs.png) |
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
:::info[Self Hosting]
|
||||||
|
If you are self-hosting the Khoj server modify the install steps below:
|
||||||
|
- Set `khoj-server-url` to your Khoj server URL. By default, use `http://127.0.0.1:42110`.
|
||||||
|
- Do not set `khoj-api-key` if your Khoj server runs in anonymous mode. For example, `khoj --anonymous-mode`
|
||||||
|
:::
|
||||||
|
|
||||||
1. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients)
|
1. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients)
|
||||||
2. Add below snippet to your Emacs config file, usually at `~/.emacs.d/init.el`
|
2. Add below snippet to your Emacs config file, usually at `~/.emacs.d/init.el`
|
||||||
|
|
||||||
|
@ -43,6 +49,7 @@ M-x package-install khoj
|
||||||
|
|
||||||
; Set your Khoj API key
|
; Set your Khoj API key
|
||||||
(setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY")
|
(setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY")
|
||||||
|
(setq khoj-server-url "https://app.khoj.dev")
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Minimal Install**
|
#### **Minimal Install**
|
||||||
|
@ -54,7 +61,8 @@ M-x package-install khoj
|
||||||
:ensure t
|
:ensure t
|
||||||
:pin melpa-stable
|
:pin melpa-stable
|
||||||
:bind ("C-c s" . 'khoj)
|
:bind ("C-c s" . 'khoj)
|
||||||
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"))
|
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
|
||||||
|
khoj-server-url "https://app.khoj.dev"))
|
||||||
```
|
```
|
||||||
|
|
||||||
#### **Standard Install**
|
#### **Standard Install**
|
||||||
|
@ -67,6 +75,7 @@ M-x package-install khoj
|
||||||
:pin melpa-stable
|
:pin melpa-stable
|
||||||
:bind ("C-c s" . 'khoj)
|
:bind ("C-c s" . 'khoj)
|
||||||
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
|
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
|
||||||
|
khoj-server-url "https://app.khoj.dev"
|
||||||
khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
||||||
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
|
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
|
||||||
```
|
```
|
||||||
|
@ -81,6 +90,7 @@ M-x package-install khoj
|
||||||
:straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
|
:straight (khoj :type git :host github :repo "khoj-ai/khoj" :files (:defaults "src/interface/emacs/khoj.el"))
|
||||||
:bind ("C-c s" . 'khoj)
|
:bind ("C-c s" . 'khoj)
|
||||||
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
|
:config (setq khoj-api-key "YOUR_KHOJ_CLOUD_API_KEY"
|
||||||
|
khoj-server-url "https://app.khoj.dev"
|
||||||
khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
khoj-org-directories '("~/docs/org-roam" "~/docs/notes")
|
||||||
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
|
khoj-org-files '("~/docs/todo.org" "~/docs/work.org")))
|
||||||
```
|
```
|
||||||
|
|
|
@ -20,11 +20,18 @@ sidebar_position: 3
|
||||||
- **Discover**: Find similar notes to the current one
|
- **Discover**: Find similar notes to the current one
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
:::info[Self Hosting]
|
||||||
|
If you are self-hosting the Khoj server, update the Khoj Obsidian plugin settings step below:
|
||||||
|
- 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. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel
|
1. Open [Khoj](https://obsidian.md/plugins?id=khoj) from the *Community plugins* tab in Obsidian settings panel
|
||||||
2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian
|
2. Click *Install*, then *Enable* on the Khoj plugin page in Obsidian
|
||||||
3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients)
|
3. Generate an API key on the [Khoj Web App](https://app.khoj.dev/settings#clients)
|
||||||
4. Set your Khoj API Key in the Khoj plugin settings in Obsidian
|
4. Set your Khoj API Key in the Khoj plugin settings on Obsidian
|
||||||
|
5. (Optional) Click `Force Sync` in the Khoj plugin settings on Obsidian to immediately sync your Obsidian vault.
|
||||||
|
<br />By default, your Obsidian vault is automatically synced periodically.
|
||||||
|
|
||||||
See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for more details on installing Obsidian plugins.
|
See the official [Obsidian Plugin Docs](https://help.obsidian.md/Extending+Obsidian/Community+plugins) for more details on installing Obsidian plugins.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue