Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.51 KB

telemetry.md

File metadata and controls

55 lines (37 loc) · 2.51 KB
Raw
title description published date tags editor
Telemetry
Help us improve Wiki.js!
true
2020-06-29 00:10:20 UTC
markdown

What is telemetry?

Telemetry allows the developers of Wiki.js to improve the software by collecting basic anonymized data about its usage and the host info.

This is entirely OPTIONAL and absolutely NO private data (such as content or personal data) is collected.

For maximum privacy, a random client ID is generated during setup. This ID is used to group requests together (instead of IP addresses) while keeping complete anonymity.

What is collected?

When telemetry is enabled, only the following data is transmitted:

  • Wiki.js version
  • Node.js version
  • OS Platform (Linux, macOS or Windows) and version
  • Total CPU Cores / RAM available
  • Type of DB (PostgreSQL, MySQL, MariaDB, SQLite or SQL Server) and version
  • Setup analytics (installation checkpoint reached)
  • Crash debug data (stack trace of the error)

Note that crash debug data is stored for a maximum of 30 days, after which it is permanently deleted.

What is it used for?

Telemetry is used by developers to improve Wiki.js, mostly for the following reasons:

  • Identify critical bugs more easily and fix them in a timely manner.
  • Understand the upgrade rate of current installations.
  • Optimize performance and testing scenarios based on most popular environments.

Only authorized developers have access to the crash debug data. It is not shared to any 3rd party nor is it used for any other application than improving Wiki.js.

📈 The aggregated anonymized telemetry stats are public and available at all times here. {.is-info}

How to enable / disable telemetry

Telemetry can be turned on / off during the installation wizard and anytime afterwards in the administration area under Utilities > Telemetry.

How to reset the client ID

A random client ID is generated at the time of installation. This client ID is used to group requests together while providing complete anonymity. In case you want to continue sending telemetry but under a new random identifier, you can simply reset the client ID in the administration area under Utilities > Telemetry. A new random client ID will be generated and used for future transmissions.

Questions / Feedback

Feel free to contact us on Slack should you have any question or feedback on telemetry.

{.align-abstopright}