From 7c29af97453dfd1ebed6ade97fadf09c75b898a9 Mon Sep 17 00:00:00 2001 From: sabaimran Date: Tue, 22 Oct 2024 22:42:27 -0700 Subject: [PATCH] Add link to self-hosted admin page and add docs for building front-end assets. Close #901 --- documentation/docs/advanced/admin.md | 2 ++ documentation/docs/contributing/development.mdx | 14 +++++++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/documentation/docs/advanced/admin.md b/documentation/docs/advanced/admin.md index 305741a8..c1d641e1 100644 --- a/documentation/docs/advanced/admin.md +++ b/documentation/docs/advanced/admin.md @@ -1,6 +1,8 @@ # Admin Panel > Describes the Khoj settings configurable via the admin panel +By default, you admin panel is available at `http://localhost:42110/server/admin/`. You can access the admin panel by logging in with your admin credentials (this would be your `KHOJ_ADMIN_EMAIL` and `KHOJ_ADMIN_PASSWORD`). The admin panel allows you to configure various settings for your Khoj server. + ## App Settings ### Agents Add all the agents you want to use for your different use-cases like Writer, Researcher, Therapist etc. diff --git a/documentation/docs/contributing/development.mdx b/documentation/docs/contributing/development.mdx index caefa3a9..b73f3948 100644 --- a/documentation/docs/contributing/development.mdx +++ b/documentation/docs/contributing/development.mdx @@ -102,7 +102,19 @@ sudo -u postgres createdb khoj --password -#### 3. Run +#### 3. Build the front-end assets + +```shell +cd src/interface/web/ +yarn install +yarn export +``` + +You can optionally use `yarn dev` to start a development server for the front-end which will be available at http://localhost:3000. This is especially useful if you're making changes to the front-end code, but not necessary for running Khoj. Note that streaming does not work on the dev server due to how it is handled with SSR in Next.js. + +Always run `yarn export` to test your front-end changes on http://localhost:42110 before creating a PR. + +#### 4. Run 1. Start Khoj ```bash khoj -vv