From 116b632a0acffc7d024c34df8874262fbb4e5d76 Mon Sep 17 00:00:00 2001 From: enoch85 Date: Tue, 25 Aug 2026 17:51:09 +0000 Subject: [PATCH] docs: correct when the usage report prompt appears in Security The report bullet said Maintainerr asks once, in the web interface, after a media server is set up. Since Maintainerr#3599 a new install is created with the setting already answered, so it reports from the start and never sees the prompt. Only installs upgrading from a version without the setting are asked, and for them "once" only holds for one of the two buttons: Keep it on saves the answer, while Turn it off in settings saves nothing and only opens the settings page, so the prompt returns on the next visit until the toggle is saved there. One sentence replaced. What the report contains, the TELEMETRY variable and the collector link are unchanged, as is the Installation.mdx row. The versioned snapshots still say no telemetry, which is true for every released version since the report ships in the next one. --- docs/Security.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Security.md b/docs/Security.md index a000a33e6..10904285c 100644 --- a/docs/Security.md +++ b/docs/Security.md @@ -24,7 +24,7 @@ Security is expected at the boundary you already control - your LAN, a VPN, or a Maintainerr is built to keep your data on your own hardware and to be careful with it internally: - **Your data stays on your hardware.** All configuration and state lives in a single SQLite database in your data directory (`/opt/data`). There is no cloud component holding any of it. Outbound traffic goes to the services you configure (your media server, the \*arrs, Seerr, and so on), to the metadata providers (TMDB/TVDB) used to match your library, and to `telemetry.maintainerr.info` for the weekly usage report below. -- **The weekly usage report is on unless you turn it off.** Once a week Maintainerr reports how it is running: its version, the platform it runs on, and which media server type is configured. Some weeks it also reports which rule properties, integrations, features, and notification agents are in use, with counts given as ranges rather than exact numbers. The report carries no identifier of any kind and nothing from your library: no account, hostname, URL, API key, library name, or media title, and no IP address is read or stored. Maintainerr asks you once in the web interface after you set up a media server, and you can change the answer at any time under **Settings > About > Help us improve it**. Setting the `TELEMETRY` environment variable to `off` disables it whatever that setting says. The [telemetry collector](https://github.com/Maintainerr/telemetry-collector) is a public repository, and its README lists every field the report can contain. +- **The weekly usage report is on unless you turn it off.** Once a week Maintainerr reports how it is running: its version, the platform it runs on, and which media server type is configured. Some weeks it also reports which rule properties, integrations, features, and notification agents are in use, with counts given as ranges rather than exact numbers. The report carries no identifier of any kind and nothing from your library: no account, hostname, URL, API key, library name, or media title, and no IP address is read or stored. New installs are not asked, the report is on from the start. If you are upgrading from a version without the report, Maintainerr asks you in the web interface once your media server is set up. `Keep it on` saves the answer and the prompt does not return. `Turn it off in settings` only opens the settings page, and until you save the toggle there the prompt appears again on the next visit. Either way you can change it at any time under **Settings > About > Help us improve it**. Setting the `TELEMETRY` environment variable to `off` disables it whatever that setting says. The [telemetry collector](https://github.com/Maintainerr/telemetry-collector) is a public repository, and its README lists every field the report can contain. - **Outbound connections use verified TLS.** Calls to your services and to metadata providers use HTTPS with normal certificate verification, which the app never disables on its own. Notification email can use TLS and can optionally be PGP-encrypted. - **Secrets are kept out of the logs.** Every log line passes through a sanitizer that masks API keys, tokens, `Authorization` headers, and credential-bearing URLs, so secrets do not leak into log files or error dumps. - **The rules engine cannot run code or shell out.** Rules are evaluated by a typed comparator, never `eval`-ed. Database access is fully parameterized, so there is no SQL-injection surface, and the server runs no shell commands. Settings you submit are schema-validated before they are saved.