etherpad

(β˜… 18,498)

Etherpad: A modern really-real-time collaborative document editor.

  • .dockerignore
  • .editorconfig
  • .env.default
  • .env.dev.default
  • .gitattributes
  • .gitignore
  • .npmrc
  • AGENTS.MD
  • CHANGELOG.md
  • CONTRIBUTING.md
  • docker-compose.dev.yml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • PRIVACY.md
  • README.md
  • SECURITY.md
  • settings.json.docker
  • settings.json.template

# Installation Guide

1. Get the code
git clone https://github.com/ether/etherpad

Downloads the entire project code from GitHub to your computer.

cd etherpad

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
curl -fsSL https://raw.githubusercontent.com/ether/etherpad/master/bin/installer.sh | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

irm https://raw.githubusercontent.com/ether/etherpad/master/bin/installer.ps1 | iex

Downloads and runs the official install script via PowerShell β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.dev.yml up -d --build

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd etherpad-lite && pnpm run prod

Moves into the project folder you just downloaded.

pnpm run plugins i ep_${plugin_name}

Type this command into your terminal and run it.

pnpm run plugins i \

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation