Skip to content

Commit d914978

Browse files
authored
Update Analytics-and-telemetry.md
1 parent 5ace434 commit d914978

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/Analytics-and-telemetry.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ id: analytics-telemetry
1111

1212
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.
1313

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.
1515
1616
## Overview
1717

@@ -116,13 +116,13 @@ Scarf is opt‑in by default (via the cookie consent banner). To disable the Sca
116116

117117
**Environment variable**
118118
```bash
119-
SYSTEM_DISABLEPIXEL=true
119+
SYSTEM_ENABLESCARF=false
120120
```
121121

122122
**settings.yml**
123123
```yaml
124124
system:
125-
disablePixel: true
125+
enableScarf: false
126126
```
127127
128128
---
@@ -168,24 +168,24 @@ system:
168168

169169
**Scarf tracking pixel**
170170
```bash
171-
SYSTEM_DISABLEPIXEL=true
171+
SYSTEM_ENABLESCARF=false
172172
```
173173
```yaml
174174
system:
175-
disablePixel: true # true | false
175+
enableScarf: false # true | false | null
176176
```
177177

178178
**Interaction**
179179
- If `enableAnalytics` is `false`, everything is off regardless of component toggles.
180180
- If `enableAnalytics` is `true`/`null`, the consent banner is shown (see below). After consent:
181181
- 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.
183183

184184
### 3) Cookie consent banner
185185

186186
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:
187187

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`)
189189
- **Accept only necessary** → disables PostHog and Scarf
190190
- **Customize** → granular selection where applicable
191191

0 commit comments

Comments
 (0)