You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Analytics-and-telemetry.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ id: analytics-telemetry
11
11
12
12
Stirling‑PDF uses analytics to understand usage patterns and improve the application. This page explains what data is collected, why we collect it, and how to disable analytics if desired.
13
13
14
-
> **User control**: All analytics are **opt‑in via a consent banner** (Disabled unless user allows) unless a self‑hosted administrator disables analytics system‑wide. If analytics are disabled system‑wide, no banner is shown.
14
+
> **User control**: All analytics are **opt‑in via a consent banner** (Disabled untill a user expressly allows it) a self‑hosted administrator can also disables all analytics system‑wide. If analytics are disabled system‑wide, no banner is shown.
15
15
16
16
## Overview
17
17
@@ -116,13 +116,13 @@ Scarf is opt‑in by default (via the cookie consent banner). To disable the Sca
116
116
117
117
**Environment variable**
118
118
```bash
119
-
SYSTEM_DISABLEPIXEL=true
119
+
SYSTEM_ENABLESCARF=false
120
120
```
121
121
122
122
**settings.yml**
123
123
```yaml
124
124
system:
125
-
disablePixel: true
125
+
enableScarf: false
126
126
```
127
127
128
128
---
@@ -168,24 +168,24 @@ system:
168
168
169
169
**Scarf tracking pixel**
170
170
```bash
171
-
SYSTEM_DISABLEPIXEL=true
171
+
SYSTEM_ENABLESCARF=false
172
172
```
173
173
```yaml
174
174
system:
175
-
disablePixel: true # true | false
175
+
enableScarf: false # true | false | null
176
176
```
177
177
178
178
**Interaction**
179
179
- If `enableAnalytics` is `false`, everything is off regardless of component toggles.
180
180
- If `enableAnalytics` is `true`/`null`, the consent banner is shown (see below). After consent:
181
181
- PostHog runs only if `enablePosthog` is `true`/`null` **and** the user consented.
182
-
- Scarf runs only if `disablePixel` is `false` **and** the user consented.
182
+
- Scarf runs only if `enableScarf` is `true`/`null` **and** the user consented.
183
183
184
184
### 3) Cookie consent banner
185
185
186
186
When analytics are allowed globally (`system.enableAnalytics: true` or resolved via the first‑run admin choice), users see a cookie consent banner on their first visit. Users can:
187
187
188
-
- **Accept all** → enables PostHog (if `enablePosthog` is `true`/`null`) and Scarf (if `disablePixel: false`)
188
+
- **Accept all** → enables PostHog (if `enablePosthog` is `true`/`null`) and Scarf (if `enableScarf` is `true`/`null`)
189
189
- **Accept only necessary** → disables PostHog and Scarf
190
190
- **Customize** → granular selection where applicable
0 commit comments