-[](https://travis-ci.org/github/ether/etherpad-lite)
+[](https://travis-ci.com/github/ether/etherpad-lite)
# About
-Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on _your_ server, under _your_ control.
+Etherpad is a real-time collaborative editor [scalable to thousands of simultaneous real time users](http://scale.etherpad.org/). It provides [full data export](https://github.com/ether/etherpad-lite/wiki/Understanding-Etherpad's-Full-Data-Export-capabilities) capabilities, and runs on _your_ server, under _your_ control.
**[Try it out](https://video.etherpad.com)**
@@ -19,7 +19,7 @@ Etherpad is a real-time collaborative editor scalable to thousands of simultaneo
### Quick install on Debian/Ubuntu
```
-curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
+curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt install -y nodejs
git clone --branch master https://github.com/ether/etherpad-lite.git && cd etherpad-lite && bin/run.sh
```
@@ -127,7 +127,8 @@ Read our [**Developer Guidelines**](https://github.com/ether/etherpad-lite/blob/
# Get in touch
The official channel for contacting the development team is via the [Github issues](https://github.com/ether/etherpad-lite/issues).
-For **responsible disclosure of vulnerabilities**, please write a mail to the maintainer (a.mux@inwind.it).
+For **responsible disclosure of vulnerabilities**, please write a mail to the maintainers (a.mux@inwind.it and contact@etherpad.org).
+Join the official [Etherpad Discord Channel](https://discord.com/invite/daEjfhw)
# HTTP API
Etherpad is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API)
diff --git a/bin/checkAllPads.js b/bin/checkAllPads.js
index 0d4e8bb8d7e..f90e57aef10 100644
--- a/bin/checkAllPads.js
+++ b/bin/checkAllPads.js
@@ -3,88 +3,85 @@
*/
if (process.argv.length != 2) {
- console.error("Use: node bin/checkAllPads.js");
+ console.error('Use: node bin/checkAllPads.js');
process.exit(1);
}
// load and initialize NPM
-let npm = require('../src/node_modules/npm');
-npm.load({}, async function() {
-
+const npm = require('../src/node_modules/npm');
+npm.load({}, async () => {
try {
// initialize the database
- let settings = require('../src/node/utils/Settings');
- let db = require('../src/node/db/DB');
+ const settings = require('../src/node/utils/Settings');
+ const db = require('../src/node/db/DB');
await db.init();
// load modules
- let Changeset = require('../src/static/js/Changeset');
- let padManager = require('../src/node/db/PadManager');
+ const Changeset = require('../src/static/js/Changeset');
+ const padManager = require('../src/node/db/PadManager');
// get all pads
- let res = await padManager.listAllPads();
-
- for (let padId of res.padIDs) {
+ const res = await padManager.listAllPads();
- let pad = await padManager.getPad(padId);
+ for (const padId of res.padIDs) {
+ const pad = await padManager.getPad(padId);
// check if the pad has a pool
if (pad.pool === undefined) {
- console.error("[" + pad.id + "] Missing attribute pool");
+ console.error(`[${pad.id}] Missing attribute pool`);
continue;
}
// create an array with key kevisions
// key revisions always save the full pad atext
- let head = pad.getHeadRevisionNumber();
- let keyRevisions = [];
+ const head = pad.getHeadRevisionNumber();
+ const keyRevisions = [];
for (let rev = 0; rev < head; rev += 100) {
keyRevisions.push(rev);
}
// run through all key revisions
- for (let keyRev of keyRevisions) {
-
+ for (const keyRev of keyRevisions) {
// create an array of revisions we need till the next keyRevision or the End
- var revisionsNeeded = [];
- for (let rev = keyRev ; rev <= keyRev + 100 && rev <= head; rev++) {
+ const revisionsNeeded = [];
+ for (let rev = keyRev; rev <= keyRev + 100 && rev <= head; rev++) {
revisionsNeeded.push(rev);
}
// this array will hold all revision changesets
- var revisions = [];
+ const revisions = [];
// run through all needed revisions and get them from the database
- for (let revNum of revisionsNeeded) {
- let revision = await db.get("pad:" + pad.id + ":revs:" + revNum);
- revisions[revNum] = revision;
+ for (const revNum of revisionsNeeded) {
+ const revision = await db.get(`pad:${pad.id}:revs:${revNum}`);
+ revisions[revNum] = revision;
}
// check if the revision exists
if (revisions[keyRev] == null) {
- console.error("[" + pad.id + "] Missing revision " + keyRev);
+ console.error(`[${pad.id}] Missing revision ${keyRev}`);
continue;
}
// check if there is a atext in the keyRevisions
if (revisions[keyRev].meta === undefined || revisions[keyRev].meta.atext === undefined) {
- console.error("[" + pad.id + "] Missing atext in revision " + keyRev);
+ console.error(`[${pad.id}] Missing atext in revision ${keyRev}`);
continue;
}
- let apool = pad.pool;
+ const apool = pad.pool;
let atext = revisions[keyRev].meta.atext;
for (let rev = keyRev + 1; rev <= keyRev + 100 && rev <= head; rev++) {
try {
- let cs = revisions[rev].changeset;
+ const cs = revisions[rev].changeset;
atext = Changeset.applyToAText(cs, atext, apool);
} catch (e) {
- console.error("[" + pad.id + "] Bad changeset at revision " + i + " - " + e.message);
+ console.error(`[${pad.id}] Bad changeset at revision ${i} - ${e.message}`);
}
}
}
- console.log("finished");
+ console.log('finished');
process.exit(0);
}
} catch (err) {
diff --git a/bin/checkPad.js b/bin/checkPad.js
index c6a3a19711b..323840e7261 100644
--- a/bin/checkPad.js
+++ b/bin/checkPad.js
@@ -3,7 +3,7 @@
*/
if (process.argv.length != 3) {
- console.error("Use: node bin/checkPad.js $PADID");
+ console.error('Use: node bin/checkPad.js $PADID');
process.exit(1);
}
@@ -11,83 +11,80 @@ if (process.argv.length != 3) {
const padId = process.argv[2];
// load and initialize NPM;
-let npm = require('../src/node_modules/npm');
-npm.load({}, async function() {
-
+const npm = require('../src/node_modules/npm');
+npm.load({}, async () => {
try {
// initialize database
- let settings = require('../src/node/utils/Settings');
- let db = require('../src/node/db/DB');
+ const settings = require('../src/node/utils/Settings');
+ const db = require('../src/node/db/DB');
await db.init();
// load modules
- let Changeset = require('ep_etherpad-lite/static/js/Changeset');
- let padManager = require('../src/node/db/PadManager');
+ const Changeset = require('ep_etherpad-lite/static/js/Changeset');
+ const padManager = require('../src/node/db/PadManager');
- let exists = await padManager.doesPadExists(padId);
+ const exists = await padManager.doesPadExists(padId);
if (!exists) {
- console.error("Pad does not exist");
+ console.error('Pad does not exist');
process.exit(1);
}
// get the pad
- let pad = await padManager.getPad(padId);
+ const pad = await padManager.getPad(padId);
// create an array with key revisions
// key revisions always save the full pad atext
- let head = pad.getHeadRevisionNumber();
- let keyRevisions = [];
+ const head = pad.getHeadRevisionNumber();
+ const keyRevisions = [];
for (let rev = 0; rev < head; rev += 100) {
keyRevisions.push(rev);
}
// run through all key revisions
- for (let keyRev of keyRevisions) {
-
+ for (const keyRev of keyRevisions) {
// create an array of revisions we need till the next keyRevision or the End
- let revisionsNeeded = [];
+ const revisionsNeeded = [];
for (let rev = keyRev; rev <= keyRev + 100 && rev <= head; rev++) {
revisionsNeeded.push(rev);
}
// this array will hold all revision changesets
- var revisions = [];
+ const revisions = [];
// run through all needed revisions and get them from the database
- for (let revNum of revisionsNeeded) {
- let revision = await db.get("pad:" + padId + ":revs:" + revNum);
+ for (const revNum of revisionsNeeded) {
+ const revision = await db.get(`pad:${padId}:revs:${revNum}`);
revisions[revNum] = revision;
}
// check if the pad has a pool
- if (pad.pool === undefined ) {
- console.error("Attribute pool is missing");
+ if (pad.pool === undefined) {
+ console.error('Attribute pool is missing');
process.exit(1);
}
// check if there is an atext in the keyRevisions
if (revisions[keyRev] === undefined || revisions[keyRev].meta === undefined || revisions[keyRev].meta.atext === undefined) {
- console.error("No atext in key revision " + keyRev);
+ console.error(`No atext in key revision ${keyRev}`);
continue;
}
- let apool = pad.pool;
+ const apool = pad.pool;
let atext = revisions[keyRev].meta.atext;
for (let rev = keyRev + 1; rev <= keyRev + 100 && rev <= head; rev++) {
try {
// console.log("check revision " + rev);
- let cs = revisions[rev].changeset;
+ const cs = revisions[rev].changeset;
atext = Changeset.applyToAText(cs, atext, apool);
- } catch(e) {
- console.error("Bad changeset at revision " + rev + " - " + e.message);
+ } catch (e) {
+ console.error(`Bad changeset at revision ${rev} - ${e.message}`);
continue;
}
}
- console.log("finished");
+ console.log('finished');
process.exit(0);
}
-
} catch (e) {
console.trace(e);
process.exit(1);
diff --git a/bin/checkPadDeltas.js b/bin/checkPadDeltas.js
index f1bd3ffe515..1e45f7148bd 100644
--- a/bin/checkPadDeltas.js
+++ b/bin/checkPadDeltas.js
@@ -1,120 +1,111 @@
-/*
- * This is a debug tool. It checks all revisions for data corruption
- */
-
-if (process.argv.length != 3) {
- console.error("Use: node bin/checkPadDeltas.js $PADID");
- process.exit(1);
-}
-
-// get the padID
-const padId = process.argv[2];
-
-// load and initialize NPM;
-var expect = require('expect.js')
-var diff = require('diff')
-var async = require('async')
-
-let npm = require('../src/node_modules/npm');
-var async = require("ep_etherpad-lite/node_modules/async");
-var Changeset = require("ep_etherpad-lite/static/js/Changeset");
-
-npm.load({}, async function() {
-
- try {
- // initialize database
- let settings = require('../src/node/utils/Settings');
- let db = require('../src/node/db/DB');
- await db.init();
-
- // load modules
- let Changeset = require('ep_etherpad-lite/static/js/Changeset');
- let padManager = require('../src/node/db/PadManager');
-
- let exists = await padManager.doesPadExists(padId);
- if (!exists) {
- console.error("Pad does not exist");
- process.exit(1);
- }
-
- // get the pad
- let pad = await padManager.getPad(padId);
-
- //create an array with key revisions
- //key revisions always save the full pad atext
- var head = pad.getHeadRevisionNumber();
- var keyRevisions = [];
- for(var i=0;i