From c837ff819e5f57a99fc22835e3de829e66cda66a Mon Sep 17 00:00:00 2001 From: timothycarambat Date: Fri, 18 Oct 2024 15:51:32 -0700 Subject: [PATCH 1/2] Config vars --- pages/_meta.json | 9 ++++++++ pages/configuration.mdx | 48 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 pages/configuration.mdx diff --git a/pages/_meta.json b/pages/_meta.json index 00772a0..d261179 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -57,6 +57,15 @@ "toc": true } }, + "configuration": { + "title": "Other configurations", + "theme": { + "breadcrumb": true, + "footer": true, + "pagination": true, + "toc": true + } + }, "-- Installation Guides": { "type": "separator", "title": "Installation Guides" diff --git a/pages/configuration.mdx b/pages/configuration.mdx new file mode 100644 index 0000000..3885e7f --- /dev/null +++ b/pages/configuration.mdx @@ -0,0 +1,48 @@ +--- +title: "Configuration" +description: "Other settings, environment variables, and configurations for AnythingLLM" +--- + +import { Callout } from "nextra/components"; + + + **Warning:** + If you are not a developer, you should not set environment variables directly. Instead, you should use the in-app interface to manage environment variables. + +**Desktop:** +If you are using AnythingLLM Desktop, do not edit the `.env` file. This guide is only for users who are using AnythingLLM Self-hosted or Docker. + + + +# Configuration of AnythingLLM + +In general, the majority of configurations you can set are through environment variables and their is an associated in-app interface to manage these variables so you don't have to setup anything manually. + +However, there are a few configurations that are not configurable via the in-app interface and require you to set environment variables directly. These are usually for more niche use cases that most users will not need. + + + **Tip:** After you set these environment variables, you will need to restart + the AnythingLLM service or container for the changes to take effect. + + +## Disable View Chat History + +Modification of the `DISABLE_VIEW_CHAT_HISTORY` environment variable allows you to disable the **frontend** ability to view chat history by anyone with an account on the instance as well as the instance admin. +This blocks any user, including yourself, from viewing chat history from users using the AnythingLLM chat interface **and** via external embed widgets. + +- **This does not impact users from seeing their own chat histories in chat or the LLM from being able to use them for queries.** +- **This does not impact the ability to use API keys to access chat histories.** +- **Chat history is not deleted when this is enabled. It is simply hidden and blocked from being viewed via the frontend admin interfaces.** + +### Enable + +Set the `DISABLE_VIEW_CHAT_HISTORY` environment variable to _any value_ to enable. + +```bash +# This can be any value, number, boolean, or string and it will have the same effect. +DISABLE_VIEW_CHAT_HISTORY="enable" +``` + +### Disable + +Fully remove or comment out the `DISABLE_VIEW_CHAT_HISTORY` environment variable to return to the default behavior. From 35ace942ad31e3d2be9c0e6618056006e6f2ce54 Mon Sep 17 00:00:00 2001 From: timothycarambat Date: Mon, 21 Oct 2024 13:25:54 -0700 Subject: [PATCH 2/2] update copy --- pages/configuration.mdx | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/pages/configuration.mdx b/pages/configuration.mdx index 3885e7f..eb37976 100644 --- a/pages/configuration.mdx +++ b/pages/configuration.mdx @@ -16,7 +16,7 @@ If you are using AnythingLLM Desktop, do not edit the `.env` file. This guide is # Configuration of AnythingLLM -In general, the majority of configurations you can set are through environment variables and their is an associated in-app interface to manage these variables so you don't have to setup anything manually. +In general, the majority of configurations you can set are through environment variables and there is typically an associated in-app interface to manage these settings so you don't have to edit them directly. However, there are a few configurations that are not configurable via the in-app interface and require you to set environment variables directly. These are usually for more niche use cases that most users will not need. @@ -27,16 +27,17 @@ However, there are a few configurations that are not configurable via the in-app ## Disable View Chat History -Modification of the `DISABLE_VIEW_CHAT_HISTORY` environment variable allows you to disable the **frontend** ability to view chat history by anyone with an account on the instance as well as the instance admin. +Modification of the `DISABLE_VIEW_CHAT_HISTORY` environment variable allows you to disable the **frontend** ability to view chat history by anyone with an account on the instance as well as the instance administrator. This blocks any user, including yourself, from viewing chat history from users using the AnythingLLM chat interface **and** via external embed widgets. -- **This does not impact users from seeing their own chat histories in chat or the LLM from being able to use them for queries.** -- **This does not impact the ability to use API keys to access chat histories.** +- **This does not impact users from seeing their own chat histories in chat or the LLM from being able to use them for continuous conversations.** +- This **does not** impact the ability to use API keys to access chat histories via the associated API endpoints. +- This will impact the ability to export chat histories via the in-app interface as well as the ability to delete chat histories. - **Chat history is not deleted when this is enabled. It is simply hidden and blocked from being viewed via the frontend admin interfaces.** ### Enable -Set the `DISABLE_VIEW_CHAT_HISTORY` environment variable to _any value_ to enable. +Set the `DISABLE_VIEW_CHAT_HISTORY` environment variable to **_any value_** to enable. ```bash # This can be any value, number, boolean, or string and it will have the same effect.