Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] instructions are not clear; Fail to install #154

Open
auniyal61 opened this issue Sep 13, 2024 · 0 comments
Open

[DOCS] instructions are not clear; Fail to install #154

auniyal61 opened this issue Sep 13, 2024 · 0 comments

Comments

@auniyal61
Copy link

Installation
npm i ep_table_of_contents ref: https://www.npmjs.com/package/ep_table_of_contents

this created package.json

restart etherpad_lite service;
Service could not restart and failed with error log, This should not have happend, as a User I should be able to opt-in or opt-out to use plugin.

Sep 13 19:29:43 fedora etherpad[303289]: [2024-09-13 19:29:43.494] [INFO] plugins - Running npm to get a list of installed plugins...                                                         
Sep 13 19:29:45 fedora etherpad[303289]: [2024-09-13 19:29:45.113] [ERROR] runCmd|npm - npm WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.js
on was generated for lockfileVersion@2. I'll try to do my best with it!                                                                                                                       
Sep 13 19:29:45 fedora etherpad[303289]: [2024-09-13 19:29:45.126] [ERROR] runCmd|npm - npm ERR! missing: [email protected], required by etherpad-lite                              
Sep 13 19:29:45 fedora etherpad[303289]: [2024-09-13 19:29:45.138] [ERROR] server - Error occurred while starting Etherpad                                                                    
Sep 13 19:29:45 fedora etherpad[303289]: [2024-09-13 19:29:45.139] [ERROR] server - Metrics at time of fatal error:       

Config:
I did not had settings.json by default in my repo root dir. So I copied settings.json.template as settings.json

added suggested key: value at the end

"ep_toc": {
  "disable_by_default": false,
  "show_button": true
},

Failed with Logs

Removed the plugin, to restore service
npm uninstall ep_table_of_contents

this updated package.json as expected

Removed added key:value from settings.json

restarted service logs:

Sep 13 19:35:55 fedora etherpad[304058]: [2024-09-13 19:35:55.993] [WARN] console - Update available: Download the actual version 2.1.1
Sep 13 19:36:14 fedora etherpad[304058]: [2024-09-13 19:36:14.584] [INFO] plugins - Running npm to get a list of installed plugins...
Sep 13 19:36:16 fedora etherpad[304058]: [2024-09-13 19:36:16.184] [ERROR] runCmd|npm - npm WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
Sep 13 19:36:17 fedora etherpad[304058]: [2024-09-13 19:36:17.186] [ERROR] runCmd|npm - npm ERR! extraneous: [email protected] /home/auniyal/custom_services/etherpad-lite/node_modules/ep_etherpad-lite
Sep 13 19:36:17 fedora etherpad[304058]: [2024-09-13 19:36:17.198] [ERROR] server - Error occurred while starting Etherpad
Sep 13 19:36:17 fedora etherpad[304058]: [2024-09-13 19:36:17.199] [ERROR] server - Metrics at time of fatal error:
Sep 13 19:36:17 fedora etherpad[304058]: {
Sep 13 19:36:17 fedora etherpad[304058]:   "httpStartTime": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "memoryUsage": 239534080,
Sep 13 19:36:17 fedora etherpad[304058]:   "memoryUsageHeap": 162607464,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_lockAwaits": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_lockAcquires": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_lockReleases": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_reads": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFailed": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFinished": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFromCache": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFromDb": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFromDbFailed": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_readsFromDbFinished": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writes": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesFailed": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesFinished": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesObsoleted": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesToDb": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesToDbFailed": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesToDbFinished": 0,
Sep 13 19:36:17 fedora etherpad[304058]:   "ueberdb_writesToDbRetried": 0
Sep 13 19:36:17 fedora etherpad[304058]: }
Sep 13 19:36:17 fedora etherpad[304058]: [2024-09-13 19:36:17.199] [ERROR] server - Error: Command exited with code 1: npm ls --long --json --depth=0 --no-production
Sep 13 19:36:17 fedora etherpad[304058]:     at exports (/home/auniyal/custom_services/etherpad-lite/src/node/utils/run_cmd.js:119:25)
Sep 13 19:36:17 fedora etherpad[304058]:     at Object.exports.getPackages (/home/auniyal/custom_services/etherpad-lite/src/static/js/pluginfw/plugins.js:115:48)
Sep 13 19:36:17 fedora etherpad[304058]:     at Object.exports.update (/home/auniyal/custom_services/etherpad-lite/src/static/js/pluginfw/plugins.js:86:34)
Sep 13 19:36:17 fedora etherpad[304058]:     at Object.exports.start (/home/auniyal/custom_services/etherpad-lite/src/node/server.js:143:19)
Sep 13 19:36:17 fedora etherpad[304058]:     at runMicrotasks (<anonymous>)

Fortunately removing setting.json restored service.

Please update the doc for end-to-end enablement in README.

Thanks

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

No branches or pull requests

1 participant