From d2ce282f9cc901f8464d1664604471ed982227a0 Mon Sep 17 00:00:00 2001
From: miloschwartz <mschwartz10612@gmail.com>
Date: Sun, 24 Aug 2025 20:40:58 -0700
Subject: [PATCH] update docs

---
 docs.json                          | 17 +++++++++---
 self-host/advanced/config-file.mdx | 12 +++++++++
 self-host/telemetry.mdx            | 42 ++++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+), 3 deletions(-)
 create mode 100644 self-host/telemetry.mdx

diff --git a/docs.json b/docs.json
index 264b636..183a49e 100644
--- a/docs.json
+++ b/docs.json
@@ -38,7 +38,11 @@
               },
               {
                 "group": "Resources",
-                "pages": ["manage/resources/targets", "manage/resources/tcp-udp-resources", "manage/resources/client-resources"]
+                "pages": [
+                  "manage/resources/targets",
+                  "manage/resources/tcp-udp-resources",
+                  "manage/resources/client-resources"
+                ]
               },
               "manage/healthchecks-failover",
               {
@@ -111,7 +115,8 @@
                   "self-host/community-guides/metrics",
                   "self-host/community-guides/homeassistant"
                 ]
-              }
+              },
+              "self-host/telemetry"
             ]
           },
           {
@@ -168,5 +173,11 @@
       "apiKey": "phc_RIHQ7o2Y2hf8qms2nP62vpoJHEvsrw6TieflQGQO7yI",
       "apiHost": "https://digpangolin.com/relay-O7yI"
     }
-  }
+  },
+  "redirects": [
+    {
+      "source": "/telemetry",
+      "destination": "/self-host/telemetry"
+    }
+  ]
 }
diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx
index d1f4f88..2808a91 100644
--- a/self-host/advanced/config-file.mdx
+++ b/self-host/advanced/config-file.mdx
@@ -91,6 +91,18 @@ This section contains the complete reference for all configuration options in `c
 
       **Default**: `false`
     </ResponseField>
+
+    <ResponseField name="telemetry" type="object">
+      Telemetry configuration settings.
+
+      <Expandable title="Telemetry">
+        <ResponseField name="anonymous_usage" type="boolean">
+          Whether to enable anonymous usage telemetry.
+
+          **Default**: `true`
+        </ResponseField>
+      </Expandable>
+    </ResponseField>
   </Expandable>
 </ResponseField>
 
diff --git a/self-host/telemetry.mdx b/self-host/telemetry.mdx
new file mode 100644
index 0000000..2720640
--- /dev/null
+++ b/self-host/telemetry.mdx
@@ -0,0 +1,42 @@
+---
+title: "Telemetry"
+description: "Understanding Pangolin's anonymous usage data collection"
+---
+
+Pangolin collects anonymous usage telemetry to help us understand how the software is used and guide future improvements and feature development.
+
+## What We Collect
+
+The telemetry system collects **anonymous, aggregated data** about your Pangolin deployment. For example:
+
+- **System metrics**: Number of sites, users, resources, and clients
+- **Usage patterns**: Resource types, protocols, and SSO configurations
+- **Performance data**: Site traffic volumes and online status
+- **Deployment info**: App version and installation timestamp
+
+## Privacy & Anonymity
+
+**No personal information is ever collected or transmitted.** All data is:
+
+- **Anonymized**: Identifying info is hashed using SHA-256
+- **Non-identifying**: Cannot be used to identify specific users or organizations
+
+## Configuration
+
+You can control telemetry collection in your `config.yml`:
+
+```yaml
+app:
+  telemetry:
+    anonymous_usage: true  # Set to false to disable
+```
+
+## What This Helps
+
+Anonymous usage data helps us:
+- Identify popular features and usage patterns
+- Prioritize development efforts
+- Improve performance and reliability
+- Make Pangolin better for everyone
+
+If you have concerns about telemetry collection, you can disable it entirely by setting `anonymous_usage: false` in your configuration.