etherpad-lite/bin/debugRun.sh

#!/bin/sh

#Move to the folder where ep-lite is installed
cd $(dirname $0)

#Was this script started in the bin folder? if yes move out
if [ -d "../bin" ]; then
  cd "../"
fi

#Prepare the environment
bin/installDeps.sh || exit 1

echo "If you are new to debugging Node.js with Chrome DevTools, take a look at this page:"
echo "https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27"
echo "Open 'chrome://inspect' on Chrome to start debugging."

#Use 0.0.0.0 to allow external connections to the debugger
#(ex: running Etherpad on a docker container). Use default port # (9229)
node --inspect=0.0.0.0:9229 node_modules/ep_etherpad-lite/node/server.js "$@"
Shell scripts are now POSIX compatible, thx @ Johannes Schauer 2011-07-26 20:28:49 +02:00			`#!/bin/sh`
Add a runDebug Script 2011-03-28 14:27:09 +02:00
improved the bin files 2011-07-27 15:37:12 +02:00			`#Move to the folder where ep-lite is installed`
bin: replace double backticks (``) with $() This has been the recommended way of launching subshells for ages, and is easier to type and on the eye. For a quick reference, see: https://unix.stackexchange.com/questions/5778/whats-the-difference-between-stuff-and-stuff#5782 2020-03-29 00:53:17 +01:00			`cd $(dirname $0)`
improved the bin files 2011-07-27 15:37:12 +02:00
			`#Was this script started in the bin folder? if yes move out`
			`if [ -d "../bin" ]; then`
			`cd "../"`
			`fi`

Typos and minor fixes in bin, doc, and root 2017-09-14 13:33:27 +02:00			`#Prepare the environment`
improved the bin files 2011-07-27 15:37:12 +02:00			`bin/installDeps.sh \|\| exit 1`

[chore] Allow debug mode on node versions >= 6.3 (#3527) I've tried to install `node-inspector` using Node 8 and it looks like it is not supported. According to the [documentation of that tool](https://www.npmjs.com/package/node-inspector): > Since version 6.3, Node.js provides a built-in DevTools-based debugger which mostly deprecates Node Inspector (...). The built-in debugger (...) provides certain advanced features (...) that are too difficult to implement in Node Inspector. As [we require nodejs >= 6.9.0](https://github.com/ether/etherpad-lite#requirements), and as [`node-inspector` only works on Chrome and Opera](https://www.npmjs.com/package/node-inspector#debug), it looks like a good approach to remove the dependency of that tool and use Chrome DevTools directly. Besides, [there are other tools available](https://nodejs.org/en/docs/guides/debugging-getting-started/#inspector-clients) for debugging, if Chrome is not an option. This PR also allow external connections to the inspector, so Etherpad instances running on containers can also be debugged. [There are obviously some risks to leave that opened on public IPs](https://nodejs.org/en/docs/guides/debugging-getting-started/#exposing-the-debug-port-publicly-is-unsafe), but I assumed no instance would run on debug mode for the final user. 2018-12-22 13:28:50 +01:00			`echo "If you are new to debugging Node.js with Chrome DevTools, take a look at this page:"`
			`echo "https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27"`
			`echo "Open 'chrome://inspect' on Chrome to start debugging."`
Add a runDebug Script 2011-03-28 14:27:09 +02:00
[chore] Allow debug mode on node versions >= 6.3 (#3527) I've tried to install `node-inspector` using Node 8 and it looks like it is not supported. According to the [documentation of that tool](https://www.npmjs.com/package/node-inspector): > Since version 6.3, Node.js provides a built-in DevTools-based debugger which mostly deprecates Node Inspector (...). The built-in debugger (...) provides certain advanced features (...) that are too difficult to implement in Node Inspector. As [we require nodejs >= 6.9.0](https://github.com/ether/etherpad-lite#requirements), and as [`node-inspector` only works on Chrome and Opera](https://www.npmjs.com/package/node-inspector#debug), it looks like a good approach to remove the dependency of that tool and use Chrome DevTools directly. Besides, [there are other tools available](https://nodejs.org/en/docs/guides/debugging-getting-started/#inspector-clients) for debugging, if Chrome is not an option. This PR also allow external connections to the inspector, so Etherpad instances running on containers can also be debugged. [There are obviously some risks to leave that opened on public IPs](https://nodejs.org/en/docs/guides/debugging-getting-started/#exposing-the-debug-port-publicly-is-unsafe), but I assumed no instance would run on debug mode for the final user. 2018-12-22 13:28:50 +01:00			`#Use 0.0.0.0 to allow external connections to the debugger`
			`#(ex: running Etherpad on a docker container). Use default port # (9229)`
startup scripts: get rid of $* and replace it with properly quoted "$@" In shell scripts an unquoted $* is rarely useful, for example because it breaks in presence of file names with spaces. References: - https://google.github.io/styleguide/shell.xml Use "$@" unless you have a specific reason to use $*. - https://unix.stackexchange.com/questions/41571/what-is-the-difference-between-and#94200 Short answer: use "$@" (note the double quotes). The other forms are very rarely useful. 2019-12-01 01:52:32 +01:00			`node --inspect=0.0.0.0:9229 node_modules/ep_etherpad-lite/node/server.js "$@"`