From 4371d61437f8f474e547fc5e47c95e4ac3ccd8ea Mon Sep 17 00:00:00 2001 From: Masen Furer Date: Wed, 20 May 2026 16:21:44 -0700 Subject: [PATCH 1/2] add doc page for telemetry info and opt-out --- docs/api-reference/telemetry.md | 30 +++++++++++++++++++ .../sidebar/sidebar_items/reference.py | 1 + 2 files changed, 31 insertions(+) create mode 100644 docs/api-reference/telemetry.md diff --git a/docs/api-reference/telemetry.md b/docs/api-reference/telemetry.md new file mode 100644 index 00000000000..8b9324d38f5 --- /dev/null +++ b/docs/api-reference/telemetry.md @@ -0,0 +1,30 @@ +# Telemetry + +Reflex collects anonymized usage statistics — counts of components and built-in features used at compile time, along with versions of Reflex, Python, and the host OS — so we can prioritize bug fixes and guide the future direction of the framework. We do **not** collect the contents of your source files, state, or any data your app handles at runtime. + +For full details, see our [Privacy Policy](https://build.reflex.dev/privacy-policy) and [Terms of Service](https://build.reflex.dev/terms-of-use). + +If you log in to [Reflex Cloud](/docs/hosting/deploy-quick-start/), your Cloud account identifier is associated with subsequent usage events from that machine. + +## Opt out + +In your `rxconfig.py`: + +```python +import reflex as rx + +config = rx.Config( + app_name="my_app", + telemetry_enabled=False, +) +``` + +Or via environment variable: + +```bash +REFLEX_TELEMETRY_ENABLED=0 reflex init --template blank +``` + +The environment variable is the only supported opt-out method for reflex +commands executed outside the context of an app directory, such as `reflex +login` and `reflex init`. diff --git a/docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/reference.py b/docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/reference.py index f61ba8e3576..62ced3ff040 100644 --- a/docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/reference.py +++ b/docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/reference.py @@ -17,6 +17,7 @@ def get_sidebar_items_api_reference(): api_reference.browser_javascript, api_reference.plugins, api_reference.utils, + api_reference.telemetry, ], ) ] From 68c1f76de77243269701c0d3f410870c89c12966 Mon Sep 17 00:00:00 2001 From: Masen Furer Date: Wed, 20 May 2026 16:29:58 -0700 Subject: [PATCH 2/2] Update docs/api-reference/telemetry.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --- docs/api-reference/telemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-reference/telemetry.md b/docs/api-reference/telemetry.md index 8b9324d38f5..f7e25b7a557 100644 --- a/docs/api-reference/telemetry.md +++ b/docs/api-reference/telemetry.md @@ -22,7 +22,7 @@ config = rx.Config( Or via environment variable: ```bash -REFLEX_TELEMETRY_ENABLED=0 reflex init --template blank +REFLEX_TELEMETRY_ENABLED=false reflex init --template blank ``` The environment variable is the only supported opt-out method for reflex