Back to Etherpad Lite

Privacy in Etherpad

PRIVACY.md

3.1.02.4 KB
Original Source

Privacy in Etherpad

What this document is

A complete, current list of every network call Etherpad's own code makes to a third party, plus how to turn each one off. Plugins are out of scope — audit any plugin you install.

TL;DR

Etherpad ships with two outbound calls to etherpad.org. Both are documented below. Both can be disabled with a single config value each. No analytics, no usage pings, no third-party SDKs at runtime.

Outbound calls

1. Version check

URLhttps://static.etherpad.org/info.json (override via updateServer)
Frequencyhourly while the server runs
PayloadGET only; User-Agent: Etherpad/<version>
Purposesurface an "update available" notice in the admin panel
Disableset privacy.updateCheck: false in settings.json
Sourcesrc/node/utils/UpdateCheck.ts

2. Plugin catalog

URLhttps://static.etherpad.org/plugins.json (override via updateServer)
Frequencyon admin-plugins page load (cached 10 min)
PayloadGET only; same User-Agent
Purposelist installable ep_* plugins in the admin UI
Disableset privacy.pluginCatalog: false in settings.json (manual install via CLI still works)
Sourcesrc/static/js/pluginfw/installer.ts

What we removed

swagger-ui-express was dropped because the upstream npm package injects a Scarf analytics pixel that cannot be disabled at install or runtime (see swagger-api/swagger-ui#10573). /api-docs is now served by a vendored copy of Scalar (MIT) with no outbound calls. The shell explicitly opts out of Scalar's default font fetch (withDefaultFonts: false) and analytics (telemetry: false), and pins a system-font stack via CSS.

@scarf/scarf is listed under ignoredBuiltDependencies in pnpm-workspace.yaml, so its postinstall pixel is suppressed even if a future transitive dep pulls Scarf in.

What we will not add

  • usage analytics or telemetry SDKs
  • crash reporters that send data without explicit opt-in
  • third-party CDN dependencies at runtime
  • dependencies whose install or runtime phones home

Plugins

Third-party plugins are out of this guarantee. Plugins run in your Etherpad process with full access; audit any plugin you install.

Reporting

Found an outbound call this doc doesn't list? Open an issue with the label privacy.