WebStorm
 
2023.2
Shortcuts: Windows
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.
  1. Running, debugging, testing, and deploying applications
  2. Deploy your application
  3. Docker
  4. Docker Compose

Docker Compose

Last modified: 07 September 2023

Docker Compose is used to run multi-container applications. For example, you can run a web server, a backend database, and your application code as separate services. Each service can be scaled by adding more containers if necessary. This enables you to perform efficient development and testing in a dynamic environment, similar to production.

Enable the Docker plugin

This functionality relies on the Docker plugin, which is bundled and enabled in WebStorm by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press CtrlAlt0S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the Docker plugin, and select the checkbox next to the plugin name.

To configure Docker Compose, open the Settings dialog (CtrlAlt0S), go to Build, Execution, Deployment | Docker | Tools, and specify the location of the Docker Compose executable file.

Docker Compose executable file

Run a multi-container Docker application

  1. Define necessary services in one or several Docker Compose files.

  2. Go to Run | Edit Configurations.

  3. Click The Add icon, point to Docker and then click Docker Compose.

    The Docker-compose configuration

  4. Specify the Docker Compose files with your service definitions. If necessary, you can define the services that this configuration will start, specify environment variables, and force building of images before starting corresponding containers (that is, add the --build option for the docker-compose up command).

    For more information about the available options, refer to Docker-compose run configuration.

  5. Click OK to save the Docker Compose run configuration, select it in the main toolbar and click the Run button or press ShiftF10 to start the configuration.

note

To quickly create a Docker-compose run configuration and run it with default settings, right-click a Docker Compose file in the Project tool window and click Run in the context menu. You can also use gutter icons and the context menu in the Docker Compose file to run and manage services.

When Docker Compose runs your multi-container application, you can use the Services tool window to control specific services and interact with containers. The containers that run as part of Docker Compose are listed under the dedicated Compose nodes, not under the Containers node (which is only for standalone containers).

Scale a service

  1. In the Services tool window, select the service you want to scale and click The Scale button or select Scale from the context menu.

    The Scale context menu item

  2. In the Scale dialog, specify how many containers you want for this service and click OK. New containers are created and started, the log is shown in the Console tab.

    Service scaled

Stop a running service

  • In the Services tool window, select the service and click The Stop button or select Stop from the context menu.

    The Stop context menu item

Stop all running services

  • In the Services tool window, select the Compose node and click The Stop button or select Stop from the context menu.

    Docker Compose stop all services

Bring your application down

  • In the Services tool window, select the Compose node and click The Down button or select Down from the context menu.

    Docker Compose remove application

This stops and removes containers along with all related networks, volumes, and images.

Open the Docker Compose file that was used to run the application

  • In the Services tool window, right-click the Compose node or a nested service node and then click Jump to Source in the context menu or press F4.

    Open the Docker Compose file