Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions content/licensing/2.telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,43 @@ To opt out, set the `TELEMETRY` [environment variable](/configuration/general#te
::callout{icon="i-lucide-info"}
Whether you can disable telemetry depends on your license. Some licenses require telemetry to remain enabled, in which case the `TELEMETRY` setting is ignored. To check whether yours allows it, review your entitlements under **Settings → License** in the Studio.
::

## Project Owner Registration

Separately from the usage data described above, Directus sends a project owner registration the first time an owner is set for your instance. This associates the project with a point of contact and, where you opt in, registers you for product updates.

Unlike the recurring usage report, it is sent only when an owner is set or changed, not on a schedule.

### What Is Sent

| Field | What it is |
| --- | --- |
| `project_owner` | The registered owner and primary contact for the instance, taken from the onboarding form or the `PROJECT_OWNER` environment variable. This is typically an email address. |
| `org_name` | The organization name entered during onboarding, if provided. |
| `project_usage` | How the project is used: `personal`, `commercial`, or `community`. |
| `product_updates` | Whether you opted in to receive product updates (`true`/`false`). |
| `project_id` | The same random project identifier used in the usage report. |
| `version` | The Directus version in use. |

### When It Is Sent

An owner is set when you:

- complete the onboarding form in the Studio,
- set the `PROJECT_OWNER` environment variable before bootstrapping a new project, or
- update the project owner in **Settings** in the Studio or through the API.

If the initial send fails, Directus retries once per day until it succeeds, then stops. Once delivered, the registration is never sent again unless the owner changes.

### Where It Is Sent

The registration is sent to `https://telemetry.directus.io`.

### Relationship to Telemetry and Licensing

This registration is independent of both the usage report and the licensing service:

- It is not controlled by the `TELEMETRY` environment variable. Setting `TELEMETRY=false` stops the usage report (entitlement permitting) but does not currently prevent the project owner registration from being sent.
- It does not contact or depend on the licensing service.

The only way to avoid sending the registration is to not set a project owner, which means skipping the onboarding form and leaving `PROJECT_OWNER` unset.
Loading