docs: add README install instructions#178
Merged
JohnMcLear merged 1 commit intomasterfrom Apr 17, 2026
Merged
Conversation
Many operators reach for "npm i ep_<plugin>" because the README doesn't say anything about how to install the plugin — but that bypasses Etherpad's plugin-manager and tends to leave the server unable to start (see e.g. ether/ep_table_of_contents#154). Add a short, uniform Installation section that points at the admin UI or "pnpm run plugins install" from the Etherpad root and explicitly warns against hand-editing package.json. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Many operators reach for
npm i ep_<plugin>because the README doesn't document the install flow — but that bypasses Etherpad's plugin-manager and typically leaves the server unable to start (cf. ether/ep_table_of_contents#154). Add a short uniform Installation section pointing at the admin UI /pnpm run plugins installand explicitly warning against hand-editingpackage.json.