Update documentation to reflect new multi-user config scenario (#550)

- Update docs to show how to use Khoj Cloud
- Move self-hosting Khoj to separate section
- Add page to setup Desktop app
- Set default URL to Khoj Cloud URL in Obsidian, Emacs clients
This commit is contained in:
Debanjum
2023-11-18 18:22:46 -08:00
committed by GitHub
24 changed files with 306 additions and 326 deletions

View File

@@ -63,7 +63,7 @@
;; Khoj Static Configuration
;; -------------------------
(defcustom khoj-server-url "http://localhost:42110"
(defcustom khoj-server-url "https://app.khoj.dev"
"Location of Khoj API server."
:group 'khoj
:type 'string)
@@ -94,7 +94,7 @@
:type 'number)
(defcustom khoj-api-key nil
"API Key to Khoj server."
"API Key to your Khoj. Default at https://app.khoj.dev/config#clients."
:group 'khoj
:type 'string)

View File

@@ -75,7 +75,7 @@ export default class Khoj extends Plugin {
if (this.settings.khojUrl === "https://app.khoj.dev") {
if (this.settings.khojApiKey === "") {
new Notice(`Khoj API key is not configured. Please visit https://app.khoj.dev to get an API key.`);
new Notice(`Khoj API key is not configured. Please visit https://app.khoj.dev/config#clients to get an API key.`);
return;
}

View File

@@ -13,7 +13,7 @@ export interface KhojSetting {
export const DEFAULT_SETTINGS: KhojSetting = {
resultsCount: 6,
khojUrl: 'http://127.0.0.1:42110',
khojUrl: 'https://app.khoj.dev',
khojApiKey: '',
connectedToBackend: false,
autoConfigure: true,

View File

@@ -2,7 +2,7 @@
{% block content %}
<div class="page">
<div class="section">
<div id="content" class="section">
<h2 class="section-title">Content</h2>
<div class="section-cards">
<div class="card">
@@ -118,7 +118,7 @@
</div>
</div>
</div>
<div class="section">
<div id ="features" class="section">
<h2 class="section-title">Features</h2>
<div id="features-hint-text"></div>
<div class="section-cards">
@@ -144,9 +144,9 @@
</div>
</div>
</div>
<div class="section">
<div id="clients" class="section">
<h2 class="section-title">Clients</h2>
<div class="api-settings">
<div id="clients-api" class="api-settings">
<div class="card-title-row">
<img class="card-icon" src="/static/assets/icons/key.svg" alt="API Key">
<h3 class="card-title">API Keys</h3>
@@ -172,7 +172,7 @@
</div>
</div>
{% if billing_enabled %}
<div class="section">
<div id="billing" class="section">
<h2 class="section-title">Billing</h2>
<div class="section-cards">
<div class="card">

View File

@@ -286,15 +286,15 @@ def generate_random_name():
# List of adjectives and nouns to choose from
adjectives = [
"happy",
"irritated",
"annoyed",
"serendipitous",
"exuberant",
"calm",
"brave",
"scared",
"energetic",
"chivalrous",
"kind",
"grumpy",
"suave",
]
nouns = ["dog", "cat", "falcon", "whale", "turtle", "rabbit", "hamster", "snake", "spider", "elephant"]