Search code examples
node.jsgoogle-chromewebkit

How do you debug a Node.js server running with Chrome/WebKit as the remote debugger?


If you have your Node running

node --debug server.js

This gives me a port number xxxx, should I use this port number when starting Chrome?

Do you remote debug into it from Google\ Chrome --remote-debugging-port=xxxx?

Or is the 9222 a magic port, as it is mentioned all over.

Am I on the right track, trying to start Chrome with --remote-debugger into the Node.js server.js


Solution

  • The node-inspector / --debug are now replaced by inspector See update below

    #now deprecated / see below for update
    
    #install node-inspector
    npm install -g node-inspector
    
    #start node-inspector, listen on port 8080 (default)
    node-inspector --web-port=8080
    
    #in another terminal session/window:
    #while node-inspector is running, start your project in debug mode 
    node --debug myproject.js
    

    Now you can browse to http://your_server:8080 for a full debug session of myproject.js

    If your remote server is not accessible on the remote port because of firewalls or other reasons, you could create an ssh-tunnel to it from port 8080 on your local machine to 'localhost:8080' on the remote server:

    ssh -L 8080:localhost:8080 username@remoteserver -N
    

    and keep this running while you use http://localhost:8080 on your local machine to debug your remote nodejs session


    Update august 2017

    Start node in inspect mode:

    node --inspect=0.0.0.0:9229 myproject.js
    

    or if you want the debugger to break at the first line of myproject.js:

    node --inspect-brk=0.0.0.0:9229 myproject.js
    

    Then open the following URL in your chrome browser:

    chrome://inspect
    

    Click the 'Configure...' button and add the following target:

    ip-or-name-of-server-running-node:9229
    

    After you click the 'Done' button, you should see myproject.js under your remote targets. Click the inspect link to start debugging. Unfortunately, the inspect link does not work on Chrome 58 for Ubuntu. It works fine on Chrome 60 for Windows.