Skip to content
This repository was archived by the owner on May 10, 2024. It is now read-only.

Commit 172ca1a

Browse files
committed
docs: Document environment variable option for telemetry opt-out
1 parent a4fd57d commit 172ca1a

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/telemetry.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,27 @@ We use this information to help us understand how Chroma is used, to help us pri
1313

1414
## **Opting out**
1515

16-
Set `anonymized_telemetry` in your clients settings to `false` to opt out of telemetry.
16+
If you prefer to opt out of telemetry, you can do this in two ways.
17+
18+
###### In Client Code
19+
20+
Set `anonymized_telemetry` to `false` in your client's settings:
1721

1822
```python
1923
from chromadb.config import Settings
2024
client = chromadb.Client(Settings(anonymized_telemetry=False))
2125
```
2226

27+
###### In Chroma's Backend Using Environment Variables
28+
29+
Set `ANONYMIZED_TELEMETRY` to `False` in your shell or server environment.
30+
31+
If you are running Chroma on your local computer with `docker-compose` you can set this value in an `.env` file placed in the same directory as the `docker-compose.yml` file:
32+
33+
```
34+
ANONYMIZED_TELEMETRY=False
35+
```
36+
2337
## **What do you track?**
2438

2539
We will only track usage details that help us make product decisions, specifically:

0 commit comments

Comments
 (0)