Node.js with Docker

Before you start

1. Install the Node.js and Node.js Remote Interpreter plugins on the Settings/Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

2. Make sure the Docker plugin is enabled on the Settings/Preferences | Plugins page, tab Installed, see Managing plugins for details.

3. Download, install, and configure Docker as described in Docker plugin integration

Create a Node.js run/debug configuration

1. From the main menu, choose Run | Edit Configuration, then in the Edit Configurations dialog, click on the toolbar and select Node.js from the list. The Run/Debug Configuration: Node.js dialog opens.

2. In the JavaScript File field, specify the path to the main file of the application that starts it (for example, bin/www for Express applications).

3. If necessary, specify some optional settings as described in Running and debugging Node.js applications.

Specify a Node.js interpreter

Select one of the configured Node.js interpreters of the type Remote Interpreter - Docker from the Node interpreter list or configure a new one.

1. In the Run/Debug Configuration: Node.js dialog, click next to the Node interpreter field.

2. In the Node.js Interpreters dialog that opens with a list of all the currently configured interpreters, click on the toolbar. In the dialog that opens, choose Add Remote from the context menu.

3. In the Configure Node.js Remote Interpreter dialog that opens, select the Docker option.

   1. In the Server field, specify the Docker configuration to use, see Working with Docker: Process overview for details. Select a configuration from the list or click and create a new configuration on the Docker page that opens.

   2. In the Image name field, specify the base Docker image to use. Choose one of the previously downloaded or your custom images from the list or type the image name manually, for example, node:argon or mhart/alpine-node. When you later launch the run configuration, Docker will search for the specified image on your machine. If the search fails, the image will be downloaded from the Docker Official Images repository on the Docker Registry page.

   3. The Node.js interpreter path field shows the location of the default Node.js interpreter from the specified image.

   4. When you click OK, CLion closes the Configure Node.js Remote Interpreter dialog and brings you to the Node.js Interpreters dialog where the new interpreter configuration is added to the list. Click OK to return to the run configuration.

Specify the Docker container settings

• Click next to the Edit Docker Container Settings field and specify the settings in the Edit Docker Container Settings dialog that opens.

• Alternatively, select the Auto configure checkbox to do it automatically. Learn more about the Auto configure mode at Quick Tour of WebStorm and Docker: What Happens On Each Run.

Configure port bindings

1. Click in the Docker Container Settings field and expand the Port bindings area in the Edit Docker Container Settings dialog that opens.

2. Click and in the Port bindings dialog that opens, map the ports as follows:

   • In the Container port field, type the port specified in your application.

   • In the Host port field, type the port through which you want to open the application in the browser from your computer.

   • Click OK to return to the Edit Docker Container Settings dialog where the new port mapping is added to the list.

3. Click OK to return to the Run/Debug Configuration: Node.js dialog.

Run your application

1. Create a Node.js configuration as described above.

2. From the Select run/debug configuration list on the toolbar, select the newly created Node.js configuration.

3. Click to the Select run/debug configuration list.

Start debugging

1. Set the breakpoints in the Node.js code as necessary.

2. Create a Node.js configuration as described above, select it from the Select run/debug configuration list on the toolbar, and click next to the list.

3. Proceed as when starting the debugger together with a Node.js application.