Skip to content

feat(Etherpad): add Etherpad real-time collaborative editor#919

Open
JohnMcLear wants to merge 1 commit into
IceWhaleTech:mainfrom
JohnMcLear:feat/add-etherpad
Open

feat(Etherpad): add Etherpad real-time collaborative editor#919
JohnMcLear wants to merge 1 commit into
IceWhaleTech:mainfrom
JohnMcLear:feat/add-etherpad

Conversation

@JohnMcLear
Copy link
Copy Markdown

Summary

Adds Etherpad to the CasaOS App Store. Etherpad is a mature open-source real-time collaborative document editor (like a self-hosted Google Docs for plain/rich text), widely used for meeting notes, shared writing, and classrooms.

Requested in ether/etherpad#7529.

Highlights

  • Native multi-arch — single etherpad/etherpad:2.6.1 tag covers amd64 and arm64 (Raspberry Pi 4/5, Zimaboard, Apple Silicon). No emulation.
  • Zero external deps — ships with the embedded "dirty" database by default, so users get a working install with one click. Power users can switch DB_TYPE via the env-var panel.
  • Persistent data — single bind mount at /DATA/AppData/$AppID/var holds pads, sessions, the dirty DB, and any installed plugins. Easy to back up.
  • Works behind CasaOS proxyTRUST_PROXY=true is the default.
  • Admin login works out of the boxAUTHENTICATION_METHOD=apikey is set explicitly; Etherpad 2.x upstream default is sso, which would surprise new CasaOS users by breaking admin login.
  • Healthcheck against /health so CasaOS status is accurate.
  • Low footprint — 256 MB memory reservation.

Files

  • Apps/Etherpad/docker-compose.yml — service definition + x-casaos metadata block with per-env descriptions, port + volume docs, and tips.before_install warning users to change ADMIN_PASSWORD from the default admin.

Not included (follow-up)

icon.png (512×512), thumbnail.png (~1200×628), and 2–3 screenshot-N.png — metadata already references them under cdn.jsdelivr.net/gh/IceWhaleTech/CasaOS-AppStore. I'll submit a follow-up PR with the assets once they're ready; happy to sourcing from ether/etherpad-lite brand assets.

Test plan

  • Fresh install from the App Store UI on amd64
  • Pad creation, multi-browser collaboration, admin panel login at /admin
  • Container restart — pads and admin password persist
  • arm64 host (Raspberry Pi 4)

Refs ether/etherpad#7529

Adds Etherpad (https://etherpad.org), a mature open-source real-time
collaborative document editor, to the CasaOS App Store.

- Apps/Etherpad/docker-compose.yml — official etherpad/etherpad:2.6.1
  image (native multi-arch amd64 + arm64), persistent volume at
  /DATA/AppData/$AppID/var, /health-based healthcheck, embedded dirty
  DB by default (zero-config, user can switch to postgres/mysql via
  env), TRUST_PROXY=true so the CasaOS reverse proxy works,
  AUTHENTICATION_METHOD=apikey so ADMIN_PASSWORD reaches the /admin UI
  (upstream 2.x default changed to sso).
- x-casaos metadata block with per-env descriptions, port + volume
  docs, and a before_install tip warning users to change
  ADMIN_PASSWORD away from the default "admin".

Not included (follow-up): icon.png, thumbnail.png, screenshot-1..3.png
— spec noted in the metadata; need brand assets from ether/etherpad-lite.

Refs ether/etherpad#7529
@sonarqubecloud
Copy link
Copy Markdown

@JohnMcLear
Copy link
Copy Markdown
Author

Anyone able to provide feedback on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant