Skip to content

Updated telemetry opt-out #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 8, 2022
Merged

Updated telemetry opt-out #831

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9efaeae
Updated the telemetry opt-out method
stb13579 Apr 5, 2022
4ec63fc
Added caution callout and small text + formatting revisions
stb13579 Apr 8, 2022
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
43 changes: 29 additions & 14 deletions docs/developer-docs/latest/getting-started/usage-information.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,36 @@ The collected data are of a non-sensitive nature and no personal data is collect

### Opt-out

You can easily disable the default data collection feature.

Should you decide to opt-out, you may do so by removing the `uuid` property in the `package.json` file located within the root of your project. This will automatically disable this feature.

```json
{
"name": "my-project",
"version": "0.1.0",
"strapi": {
"uuid": "7b581c0d-89b7-479e-b379-a76ab90b8754"
},
"license": "SEE LICENSE IN LICENSE"
}
::: caution
Strapi previously recommended disabling data collection by removing the `uuid` property in the `package.json` file located in the project root. While this method will still work it is discouraged since the `uuid` might be required for certain project functionality and adding a `uuid` at a later date would re-enable data collection without informing the user.
:::

The default data collection feature can be disabled using the following CLI command:

<code-group>

<code-block title="NPM">
```jsx
//disable telemetry in a Strapi application

npm run strapi telemetry:disable

```
</code-block>

<code-block title="YARN">
```jsx
//disable telemetry in a Strapi application

yarn strapi telemetry:disable
```

</code-block>

</code-group>

Alternatively, the `telemetryDisabled: true` flag in the project `package.json` file will also disable data collection. Deleting the flag or setting it to false will re-enable data collection.

::: note
Should you have any questions regarding this feature, feel free to email [privacy@strapi.io](mailto:privacy@strapi.io).
If you have any questions or concerns regarding data collection, please contact us at the following email address [privacy@strapi.io](mailto:privacy@strapi.io).
:::