# Etherpad

Etherpad is an open-source, web-based collaborative real-time editor that enables multiple users to simultaneously edit a document from different locations. It is open source and self-hosted, installable on Docker Hub, Proxmox, ZimaOS, Kubernetes (Helm) and Umbrel.

Canonical page: https://ourlocalhost.com/app/3552/etherpad

## Description

Etherpad is an open-source, web-based collaborative real-time editor that enables multiple users to simultaneously edit a document from different locations. It is particularly valuable for teamwork, group projects, or situations where many people need to contribute to the same document at once. As users make changes, those changes appear in real-time for all participants, with each user's contributions color-coded to distinguish them. The platform is designed to be simple and intuitive, with a clean and straightforward interface that emphasizes writing and editing.

## Platform availability

Available on 6 of 10 platforms: Umbrel, ZimaOS, Proxmox, Helm, Windows, Any server.

## Desktop and other devices

Windows.

## Health score

86/100 (Excellent), based on 5 of 5 factors.
- Maintained: 100 (last commit 12 days ago)
- Popular: 85 (18,623 GitHub stars)
- Easy to install: 85 (6 install platforms, install notes, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)
- Security check: 78 (no serious findings, 2 minor, CI, tests, new single-developer project)

## Links

- desktop: https://github.com/ether/pad/releases/latest
- GitHub: https://github.com/ether/etherpad-lite
- Docker Hub: https://hub.docker.com/r/etherpad/etherpad
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=etherpad
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/Etherpad
- Kubernetes (Helm): https://artifacthub.io/packages/helm/nicholaswilde/etherpad
- Official website: https://etherpad.org
- Umbrel: https://apps.umbrel.com/app/etherpad
- Documentation: https://etherpad.org/doc/v3.3.7/index.html

## Common questions

### Why might the official one-line installer complete but not open an Etherpad page?

Set ETHERPAD_RUN=1 when using the official installer. That makes the installer install the code, build the web assets, and start the server; without the flag, setup may finish but the web server may not start.

### Which port should I expose for Etherpad and how can I verify that it is ready?

Etherpad examples use port 9001 for the web app. Check the 9001 health endpoint, and if it does not return a passing result, the app is not ready yet.

### How do I tell Etherpad to use a custom settings file instead of defaults?

Start Etherpad with bin/run.sh --settings /path/to/thatSettingsFile.json. If you omit the --settings flag, Etherpad uses its default settings instead of the file you prepared.

### Can Etherpad be configured with OAuth, LDAP, or OpenID authentication?

Yes, the project page lists OAuth, LDAP, and OpenID auth among plugin extensions.

## Alternatives

- CryptPad: CryptPad is a zero-knowledge, real-time collaborative editor.
- EtherCalc: EtherCalc is a web spreadsheet.
- Google Docs: Online word processor offering real-time collaboration, document conversion, robust formatting, revision history, redownloading, and langua…
- HedgeDoc: HedgeDoc is a self-hosted, real-time collaborative Markdown editor for creating and sharing notes, documents, and wikis with multiple contr…
- La Suite Docs: Collaborative platform for real-time note-taking, documentation, and wikis, with offline support, granular permissions, AI tools, and multi…
- Microsoft Word: Widely-used word processor offering extensive document editing tools, SmartArt, PDF support, and integrated search features on multiple pla…
- Nuclino: Nuclino is a digital workspace for teams to organise notes, tasks, and documents in one searchable place.
- Wordcraft: WordCraft is a fast, open-source word processor and document-design tool that reads and writes .docx files using the familiar Microsoft Wor…

---
Source: Our Local Host (https://ourlocalhost.com/app/3552/etherpad), the self-hosted and open-source app directory.
