From 29a64be9390e21b08f9c4a3c4b1815d8eb2cd18c Mon Sep 17 00:00:00 2001 From: sabaimran Date: Mon, 25 Sep 2023 22:02:02 -0700 Subject: [PATCH] Deprecate desktop build instructions from old setup --- docs/_sidebar.md | 2 -- docs/desktop_installation.md | 2 +- docs/setup.md | 13 ++++++++++--- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 71c9ed1f..9e0b8849 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,8 +1,6 @@ - Get Started - [Overview](README.md) - [Install](setup.md) - - [Desktop Installation](desktop_installation.md) - - [Windows Installation](windows_install.md) - [Demos](demos.md) - Use - [Features](features.md) diff --git a/docs/desktop_installation.md b/docs/desktop_installation.md index c0481c0f..d79a282f 100644 --- a/docs/desktop_installation.md +++ b/docs/desktop_installation.md @@ -1,4 +1,4 @@ -# Installing the Desktop Application +# Installing the Desktop Application [Deprecated -- for 0.11.4 and below] We have beta desktop images available for download with new releases. This is recommended if you don't want to bother with the command line. Download the latest release from [here](https://github.com/khoj-ai/khoj/releases). You can find the latest release under the `Assets` section. diff --git a/docs/setup.md b/docs/setup.md index cff791d4..861b9883 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -45,11 +45,18 @@ 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. +### 1.2 Select files for indexing using the desktop client [Optional] -**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. +You can use our desktop executables to select file paths and folders to index. 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. 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. +**To download the desktop client, 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. + +### 1.3 Use (deprecated) desktop builds + +Before v0.11.4, we had self-contained desktop builds that included both the server and the client. These were difficult to maintain, but are still available as part of earlier releases. To find setup instructions, see here: + +- [Desktop Installation](desktop_installation.md) +- [Windows Installation](windows_install.md) ### 2. Configure 1. Set `File`, `Folder` and hit `Save` in each Plugins you want to enable for Search on the Khoj config page