Skip to content

Commit 6c15668

Browse files
committed
docs(gdpr): privacyBanner configuration section
1 parent 0eec0ac commit 6c15668

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

doc/privacy.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Privacy
2+
3+
See [cookies.md](cookies.md) for the cookie list and the GDPR work
4+
tracked in [ether/etherpad#6701](https://github.com/ether/etherpad/issues/6701).
5+
The full operator-facing privacy statement (including IP-logging
6+
behaviour) is covered by the companion PR that lands alongside this
7+
change.
8+
9+
## Privacy banner (optional)
10+
11+
The `privacyBanner` block in `settings.json` lets you display a short
12+
notice to every pad user — data-processing statement, retention
13+
policy, contact for erasure requests, etc.
14+
15+
```jsonc
16+
"privacyBanner": {
17+
"enabled": true,
18+
"title": "Privacy notice",
19+
"body": "This instance stores pad content for 90 days. Contact privacy@example.com to request erasure.",
20+
"learnMoreUrl": "https://example.com/privacy",
21+
"dismissal": "dismissible"
22+
}
23+
```
24+
25+
The banner is rendered from plain text (HTML is escaped) with one
26+
paragraph per line. With `dismissal: "dismissible"` the user can close
27+
the banner and the choice is remembered in `localStorage` per origin.
28+
`dismissal: "sticky"` removes the close button so the notice is shown
29+
on every pad load.

0 commit comments

Comments
 (0)