kamp/anything-llm
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anything-llm.git synced 2024-11-14 02:20:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

patch readme

Browse Source
This commit is contained in:
timothycarambat 2024-04-04 20:21:10 -07:00
parent 8c7379cda1
commit cf5fb4c029
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -135,30 +135,27 @@ Mintplex Labs & the community maintain a number of deployment methods, scripts,
- create PR with branch name format of `<issue number>-<short name>` - create PR with branch name format of `<issue number>-<short name>`
- yee haw let's merge - yee haw let's merge
<details>
<summary><kbd>Telemetry for AnythingLLM</kbd></summary>
## Telemetry ## Telemetry & Privacy
AnythingLLM by Mintplex Labs Inc contains a telemetry feature that collects anonymous usage information. AnythingLLM by Mintplex Labs Inc contains a telemetry feature that collects anonymous usage information.
<details>
<summary><kbd>More about Telemetry & Privacy for AnythingLLM</kbd></summary>
### Why? ### Why?
We use this information to help us understand how AnythingLLM is used, to help us prioritize work on new features and bug fixes, and to help us improve AnythingLLM's performance and stability. We use this information to help us understand how AnythingLLM is used, to help us prioritize work on new features and bug fixes, and to help us improve AnythingLLM's performance and stability.
### Opting out ### Opting out
Set `DISABLE_TELEMETRY` in your server or docker .env settings to "true" to opt out of telemetry. Set `DISABLE_TELEMETRY` in your server or docker .env settings to "true" to opt out of telemetry. You can also do this in-app by going to the sidebar > `Privacy` and disabling telemetry.
```
DISABLE_TELEMETRY="true"
```
### What do you explicitly track? ### What do you explicitly track?
We will only track usage details that help us make product and roadmap decisions, specifically: We will only track usage details that help us make product and roadmap decisions, specifically:
- Version of your installation - Typ of your installation (Docker or Desktop)
- When a document is added or removed. No information _about_ the document. Just that the event occurred. This gives us an idea of use. - When a document is added or removed. No information _about_ the document. Just that the event occurred. This gives us an idea of use.
- Type of vector database in use. Let's us know which vector database provider is the most used to prioritize changes when updates arrive for that provider. - Type of vector database in use. Let's us know which vector database provider is the most used to prioritize changes when updates arrive for that provider.
- Type of LLM in use. Let's us know the most popular choice and prioritize changes when updates arrive for that provider. - Type of LLM in use. Let's us know the most popular choice and prioritize changes when updates arrive for that provider.
@ -166,6 +163,8 @@ We will only track usage details that help us make product and roadmap decisions
You can verify these claims by finding all locations `Telemetry.sendTelemetry` is called. Additionally these events are written to the output log so you can also see the specific data which was sent - if enabled. No IP or other identifying information is collected. The Telemetry provider is [PostHog](https://posthog.com/) - an open-source telemetry collection service. You can verify these claims by finding all locations `Telemetry.sendTelemetry` is called. Additionally these events are written to the output log so you can also see the specific data which was sent - if enabled. No IP or other identifying information is collected. The Telemetry provider is [PostHog](https://posthog.com/) - an open-source telemetry collection service.
[View all telemetry events in source code](https://github.com/search?q=repo%3AMintplex-Labs%2Fanything-llm%20.sendTelemetry\(&type=code)
</details> </details>
## 🔗 More Products ## 🔗 More Products