mirror of
https://github.com/khoj-ai/khoj.git
synced 2024-12-19 10:57:45 +00:00
9acc722f7f
### ✨ New - Use API keys to authenticate from Desktop, Obsidian, Emacs clients - Create API, UI on web app config page to CRUD API Keys - Create user API keys table and functions to CRUD them in Database ### 🧪 Improve - Default to better search model, [gte-small](https://huggingface.co/thenlper/gte-small), to improve search quality - Only load chat model to GPU if enough space, throw error on load failure - Show encoding progress, truncate headings to max chars supported - Add instruction to create db in Django DB setup Readme ### ⚙️ Fix - Fix error handling when configure offline chat via Web UI - Do not warn in anon mode about Google OAuth env vars not being set - Fix path to load static files when server started from project root |
||
|---|---|---|
| .. | ||
| assets | ||
| chat.html | ||
| config.html | ||
| index.html | ||
| main.js | ||
| package.json | ||
| preload.js | ||
| README.md | ||
| renderer.js | ||
| todesktop.json | ||
| yarn.lock | ||
Run it locally
Prerequisites
Install the runtime dependencies. This command should install all dev dependencies.
yarn add
Run the application
yarn start
Deploying the Electron App
Prerequisites
Install the ToDesktop CLI. Full documentation can be found here: https://www.npmjs.com/package/@todesktop/cli
yarn global add @todesktop/cli
Configure the todesktop.json file. Fill in the id based on the application ID.
Build
This will prompt you to login. It triggers builds for all platforms.
todesktop build
If you get an error saying the command is not found, make sure that your yarn global bin directory is in your PATH environment variable. You can find the location of the global bin directory by running yarn global bin. Add this line to your .bashrc or .zshrc file: export PATH="$PATH:$(yarn global bin)".