From 7eabf8ab0f4e64b74d3785bbfce57280c7455d55 Mon Sep 17 00:00:00 2001
From: Saba <narmiabas@gmail.com>
Date: Sun, 30 Jul 2023 22:26:52 -0700
Subject: [PATCH] Add instructions for installing the desktop app and opting
 out of telemetry

---
 docs/_sidebar.md             |  4 +++-
 docs/credits.md              |  1 +
 docs/desktop_installation.md | 29 +++++++++++++++++++++++++++++
 docs/telemetry.md            | 17 +++++++++++++++++
 4 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 docs/desktop_installation.md
 create mode 100644 docs/telemetry.md

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index a02a86b0..71c9ed1f 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -1,6 +1,7 @@
 - Get Started
     - [Overview](README.md)
     - [Install](setup.md)
+        - [Desktop Installation](desktop_installation.md)
         - [Windows Installation](windows_install.md)
     - [Demos](demos.md)
 - Use
@@ -11,10 +12,11 @@
         - [Obsidian](obsidian.md)
         - [Emacs](emacs.md)
         - [Web](web.md)
-    - Data Sources
+    - Online Data Sources
         - [Github](github_integration.md)
         - [Notion](notion_integration.md)
 - Miscellaneous
+    - [Telemetry](telemetry.md)
     - [Advanced](advanced.md)
     - [Performance](performance.md)
     - [Credits](credits.md)
diff --git a/docs/credits.md b/docs/credits.md
index a3032dce..e0005a8a 100644
--- a/docs/credits.md
+++ b/docs/credits.md
@@ -5,3 +5,4 @@
 - Charles Cave for [OrgNode Parser](http://members.optusnet.com.au/~charles57/GTD/orgnode.html)
 - [Org.js](https://mooz.github.io/org-js/) to render Org-mode results on the Web interface
 - [Markdown-it](https://github.com/markdown-it/markdown-it) to render Markdown results on the Web interface
+- [GPT4All](https://github.com/nomic-ai/gpt4all) to chat with local LLM
diff --git a/docs/desktop_installation.md b/docs/desktop_installation.md
new file mode 100644
index 00000000..b2b6de5f
--- /dev/null
+++ b/docs/desktop_installation.md
@@ -0,0 +1,29 @@
+# Installing the Desktop Application
+
+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.
+
+## MacOS
+
+1. Download the latest release from [here](https://github.com/khoj-ai/khoj/releases).
+    - If your Mac uses one of the Silicon chips, then download the `Khoj_<version>_arm64.dmg` file. Otherwise, download the `Khoj_<version>_amd64.dmg` file.
+2. Open the downloaded file and drag the Khoj app to your Applications folder.
+
+## Windows
+
+Make sure you meet the prerequisites for Windows installation. You can find them [here](windows_install.md#prerequisites).
+
+1. Download the latest release from [here](https://github.com/khoj-ai/khoj/releases). You'll want the `khoj_<version>_amd64.exe` file.
+2. Open the downloaded file and double click to install.
+
+## Linux
+1. Download the latest release from [here](https://github.com/khoj-ai/khoj/releases). You'll want the `khoj_<version>_amd64.deb` file.
+2. In your downloads folder, run `sudo dpkg -i khoj_<version>_amd64.deb` to install Khoj.
+
+
+# Uninstall
+
+If you decide you want to uninstall the application, you can uninstall it like any other application on your system. For example, on MacOS, you can drag the application to the trash. On Windows, you can uninstall it from the `Add or Remove Programs` menu. On Linux, you can uninstall it with `sudo apt remove khoj`.
+
+In addition to that, you might want to `rm -rf` the following directories:
+- `~/.khoj`
+- `~/.cache/gpt4all`
diff --git a/docs/telemetry.md b/docs/telemetry.md
new file mode 100644
index 00000000..efa409a1
--- /dev/null
+++ b/docs/telemetry.md
@@ -0,0 +1,17 @@
+# Telemetry
+
+We collect some high level, anonymized metadata about usage of Khoj and send it to Posthog. This includes:
+- Client (Web, Emacs, Obsidian)
+- API usage (Search, Chat)
+- Configured content types (Github, Org, etc)
+
+We don't send any personal information or any information about your content. We only send the above metadata, as well as some basic request metadata (e.g., host, referrer). This helps us prioritize feature development and understand how people are using Khoj. Don't just take our word for it -- you can see [the code here](https://github.com/khoj-ai/khoj/tree/master/src/telemetry).
+
+## Disable Telemetry
+
+You can opt out of telemetry at any time. To do so,
+1. Open `~/.khoj/khoj.yml`
+2. Set `should-log-telemetry` to `false`
+3. Save the file and restart Khoj
+
+If you have any questions or concerns, please reach out to us on [Discord](https://discord.gg/BDgyabRM6e).