Skip to content

Commit

Permalink
docs: add information about telemetry
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnisDa committed Nov 24, 2024
1 parent 6722ceb commit d5f1e11
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,12 @@ Once you have the key, you can set it in the `docker-compose.yml` file:
If the key is invalid or your subscription has expired, the server will automatically start
with the community version. Since the two versions are compatible, you can switch between
them by simply fixing the key and restarting the server.

## Telemetry

Ryot collects anonymous usage data to help me prioritize features. It uses a self-hosted
[Umami](https://umami.is/) instance to collect this data. In addition to page views, a
few events are also tracked and you can find them in the [source code](https://github.com/IgnisDa/ryot/blob/6722ceb913a9c2fd67392d5812b76a30036142d1/apps/frontend/app/lib/hooks.ts#L140-L174).

You can opt out of this by setting a configuration parameter as described
[here](./configuration.md#important-parameters).

0 comments on commit d5f1e11

Please sign in to comment.