WebStorm
 
2023.2
Shortcuts: Windows
Get WebStorm
You are viewing the documentation for an earlier version of WebStorm.
  1. Reference
  2. Tool windows reference
  3. Services tool window

Services tool window

Last modified: 20 September 2023

View | Tool Windows | Services or Alt08

The Services tool window enables you to manage various services that help you during software development, such as run/debug configurations, application servers, database sessions, and Docker connections. Plugin developers can add other services through the IntelliJ platform API.

The main toolbar contains the following buttons and menus that are common for all service types:

The Expand All button

Expand All CtrlNumPad +

Expand all items in the list.

The Collapse All button

Collapse All CtrlNumPad -

Collapse all items in the list.

The Group By menu

Group By

Choose how you want to organize the list of services:

  • Service Type: arrange services by type, such as Run Dashboard, Docker, or Database

  • Service Groups: arrange services by group, such as a build tool or a data source name

The Filter menu

Filter

Choose how you want to filter the list of services.

The Open in New Tab button

Open in New Tab

Move the selected items to a separate tab.

The Add Service menu

Add Service AltInsert

Choose a service type to add.

Run/debug configurations

Run/debug configurations are not listed in the Services tool window by default. You need to explicitly specify the types of configurations you want to be available and create the corresponding configurations.

Add Run/Debug configurations to the Services window

  1. Select View | Tool Windows | Services from the main menu or press Alt08.

  2. In the Services tool window, click Add service, then select Run Configuration Type.

    Services tool window: Add run configuration

  3. Select a run/debug configuration type from the list to add all configurations of this type to the window.

    Note that the tool window will only display the configuration types for which you have created one or more configurations.

Buttons on the toolbar depend on the selected type of the run/debug configuration and can include the following:

The Run button

Run CtrlShiftF10

Run the selected configuration.

The Debug button

Debug

Run the selected configuration in Debug mode.

The Stop button

Stop CtrlF2

Stop the selected configuration.

The Rerun button

Rerun CtrlShiftF10

Rerun the selected configuration.

The Rerun in Debug Mode button

Rerun in Debug Mode

Rerun the selected configuration in Debug mode.

The Filters menu

Filters

Filter the output for the selected configuration. For example, you can select to show warnings and successful steps.

The More menu

More

Additional actions related to the configuration. For example, you can open and modify the settings of the selected configuration.

Database service

In the database service, you can manage your sessions and connections. Connection is a physical communication channel and session is a state of information exchange. For example, if you surf a social network, your connection log might have thousands of connection entries between a client and a server while a session log might show you only a single log entry with the number of bytes transferred.

For more information about managing database sessions, refer to Sessions.

Database services in the Services tool window

Left toolbar controls

Data sources

Icon

Action and shortcut

Description

The Jump to Console button

Jump to Query Console CtrlShiftF10

Open the Query Consoles popup. In the Query Consoles popup, you can select a query console that you want to open in the editor.

the Deactivate icon

Deactivate CtrlF2

Close the database connection for the selected data source or data sources. (The data sources with connected sessions are indicated with a green dot in the corner of their icon.)

Sessions

Icon

Action and shortcut

Description

Tx

Transaction Mode

and

Transaction Isolation

Select the isolation level for database transactions and the way the transactions are committed.

  • Auto: the current transaction is committed automatically when you submit your local changes to the database server.

  • Manual: the changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back explicitly by means of the Submit and Commit (the Submit and Commit icon) or Roll Back (the Roll Back button) buttons on the toolbar.

For more information about database transaction modes and isolation, refer to Submit changes to a database.

the Commit icon

Commit

Commit the current transaction. This button is available only for the manual transaction mode. See also, transaction mode and isolation.

the Roll back icon

Roll back

Roll back changes. This button is available only for the manual transaction mode. See also, transaction modes and isolation.

the Cancel Running Statements icon

Cancel Running Statements

CtrlF2

Terminate execution of the current statement or statements.

the Restore Default Layout button

Restore Default Layout

Restore default positions of visual elements in the tool window.

Context menu

Data sources

Icon

Action and shortcut

Description

The Jump to Console button

Jump to Query Console CtrlShiftF10

Open the Query Consoles popup. In the Query Consoles popup, you can select a query console that you want to open in the editor.

the Deactivate icon

Deactivate CtrlF2

Close the database connection for the selected data source or data sources. (The data sources with connected sessions are indicated with a green dot in the corner of their icon.)

Close All Sessions

Close all opened sessions to a data source.

Open in New Tab

Move the selected items to a separate tab.

Open Each in New Tab

Split the selected items into separate tabs.

Open Each Type in New Tab

Create separate tabs for each type of service.

Delete Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

Sessions

Icon

Action and shortcut

Description

Tx

Transaction Mode

and

Transaction Isolation

Select the isolation level for database transactions and the way the transactions are committed.

  • Auto: the current transaction is committed automatically when you submit your local changes to the database server.

  • Manual: the changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back explicitly by means of the Submit and Commit (the Submit and Commit icon) or Roll Back (the Roll Back button) buttons on the toolbar.

For more information about database transaction modes and isolation, refer to Submit changes to a database.

the Commit icon

Commit

Commit the current transaction. This button is available only for the manual transaction mode. See also, transaction mode and isolation.

the Roll back icon

Roll back

Roll back changes. This button is available only for the manual transaction mode. See also, transaction modes and isolation.

the Cancel Running Statements icon

Cancel Running Statements

CtrlF2

Terminate execution of the current statement or statements.

the Restore Default Layout button

Restore Default Layout

Restore default positions of visual elements in the tool window.

Rename Session ShiftF6

Display the Rename Session '<session_name>' dialog where you can specify a name for a session.

Close Session

Close the selected session.

Open in New Tab

Move the selected items to a separate tab.

Open Each in New Tab

Split the selected items into separate tabs.

Open Each Type in New Tab

Create separate tabs for each type of service.

Delete Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

SQL files

Icon

Action and shortcut

Description

Tx

Transaction Mode

and

Transaction Isolation

Select the isolation level for database transactions and the way the transactions are committed.

  • Auto: the current transaction is committed automatically when you submit your local changes to the database server.

  • Manual: the changes submitted to the database server are accumulated in a transaction that can either be committed or rolled back explicitly by means of the Submit and Commit (the Submit and Commit icon) or Roll Back (the Roll Back button) buttons on the toolbar.

For more information about database transaction modes and isolation, refer to Submit changes to a database.

the Commit icon

Commit

Commit the current transaction. This button is available only for the manual transaction mode. See also, transaction mode and isolation.

the Roll back icon

Roll back

Roll back changes. This button is available only for the manual transaction mode. See also, transaction modes and isolation.

the Cancel Running Statements icon

Cancel Running Statements

CtrlF2

Terminate execution of the current statement or statements.

the Restore Default Layout button

Restore Default Layout

Restore default positions of visual elements in the tool window.

Attach Session

Attach the selected file to one of the available sessions. To detach the file from a session, open the file in the editor, click the <session> list and select Detach Session.

Open in New Tab

Move the selected items to a separate tab.

Open Each in New Tab

Split the selected items into separate tabs.

Open Each Type in New Tab

Create separate tabs for each type of service.

Delete Delete

Close all opened sessions to a data source. Identical to Close All Sessions.

the Jump to Source button

Jump to Source F4

Open the file in the editor.

Docker

This type of service is available if you have configured connection settings for at least one Docker instance. For more information, refer to Connect to the Docker daemon.

Add a Docker connection

  1. Click the New Service menu and select Docker Connection.

  2. Configure the docker connection settings in the New Docker Connection dialog.

tip

If you have Docker contexts configured, you can select Docker Connections from Docker Contexts to add the corresponding connections.

Main Docker node

These are the main actions for working with the selected Docker connection:

Icon

Action

Description

The Connect button

Connect

Connect to the Docker daemon and list all available images and containers.

The Disconnect button

Disconnect

Disconnect from the Docker daemon.

The Edit Configuration button

Edit Configuration

Edit the Docker connection settings.

The Deploy button

Deploy

Select an existing Docker run configuration or create a new one. For more information, refer to Docker containers

Delete Connections

Delete Connections

Delete the connection to the selected Docker daemon.

The Pull Image button

Pull Image…

Pull an image from a Docker registry. For more information, refer to Pull a public image from Docker Hub.

The Clean Up button

Clean Up

Remove all stopped containers, unused volumes and networks, dangling images, and all build caches.

Containers

This node lists all containers managed by the corresponding Docker daemon.

Icon

Action

Description

The Clean Up button

Clean Up

Remove all stopped containers.

When you select a container, the following actions are available:

Icon

Action

Description

The Start Container button

Start Container

Run the selected container.

The Stop Container button

Stop Container

Stop the selected container.

The Delete Container button

Delete Container

Delete the selected container.

Container dashboard

The Dashboard tab provides important information about the selected container:

  • Name and hash ID of the container. You can click the image name to highlight the image that was used to run the selected container.

  • Names and values of environment variables defined in the container.

  • Ports mappings between the container and the host.

  • Volume bindings between the container and the host.

Click Add to add a new variable, port binding, or volume binding, and recreate the container.

Click the More button to open a menu with some additional actions:

Action

Description

Show Log

Open a tab with the log messages from the container's standard output streams: STDOUT and STDERR.

For more information, refer to the docker logs command reference.

Show Files

Open a tab with the file browser for the running container.

Select any file and click The View in Editor button to open it remotely in the editor or click The Download to Scratches button to create a copy of the file as a scratch.

note

The file browser may not work by default for containers that don't have the full ls package (for example, images that are based on Alpine, Photon, and BusyBox). To use it, you can add the following command in the Dockerfile: 

FROM alpine:3.10
RUN apk add coreutils
FROM photon:3.0
RUN echo y | tdnf remove toybox

Inspect

Run docker inspect on the container and output it to a separate tab.

Copy Image ID

Copy the hash ID of the image used to run this container.

Copy Container ID

Copy the hash ID of the container.

Images

This node lists all images managed by the corresponding Docker daemon.

Icon

Action

Description

The Pull Image button

Pull Image…

Pull an image from a Docker registry. For more information, refer to Pull a public image from Docker Hub.

The Clean Up button

Clean Up

Remove all unused images.

When you select an image, the following actions are available:

Icon

Action

Description

The Create Container button

Create Container

Create a Docker container from the selected image.

The Delete Image button

Delete Image

Remove the selected image.

The Copy Docker Image button

Copy Docker Image

Copy an image from one Docker daemon to another. For more information, refer to Copy image to another Docker daemon.

The Push Image button

Push Image…

Push an image to a Docker registry. For more information, refer to Push an image to a Docker registry.

Image dashboard

The Dashboard tab provides important information about the selected image:

  • Name, hash ID, date of latest changes, and size of the image.

  • List of tags that point to the image.

  • List of existing containers created from this image.

It also includes some useful actions for the selected image:

Action

Description

The Create Container button Create Container

Create a Docker container from the selected image.

The Push Image button Push Image

Push an image to a Docker registry. For more information, refer to Push an image to a Docker registry.

The Show Layers button Show Layers

Open a tab that shows the layers (intermediate internal untagged images) from which the selected image consists.

Click the More button to open a menu with some additional actions:

Action

Description

Copy Image ID

Copy the hash ID of the selected image.

Inspect

Run docker inspect on the selected image and output it to a separate tab.

Show Labels

Open a tab with the image's labels.

Networks

This node lists all networks managed by the corresponding Docker daemon.

Icon

Action

Description

The Create Network button

Create Network

Create a Docker network for your containers to operate.

The Clean Up button

Clean Up

Remove all unused networks.

Network dashboard

The Dashboard tab provides important information about the selected network:

  • Name and hash ID of the network.

  • List of containers connected to this network.

  • List of labels assigned to this network.

Click Inspect to run docker inspect on the selected network and output it to a separate tab.

Volumes

This node lists all volumes managed by the corresponding Docker daemon.

Icon

Action

Description

The Create Volume button

Create Volume

Create a Docker volume for your containers to use.

The Clean Up button

Clean Up

Remove all unused volumes.

When you select a volume, the following actions are available:

Icon

Action

Description

The Delete Volume button

Delete Volume

Remove the selected volume.

Volume dashboard

The Dashboard tab provides important information about the selected volume:

  • Name or hash ID of the volume.

  • List of containers that use this volume.

It also includes some useful actions for the selected volume:

Action

Description

The Inspect button Inspect

Run docker inspect on the selected image and output it to a separate tab.

The Delete Volume button Remove

Remove the selected volume.

Click the More button to open a menu with some additional actions:

Action

Description

Show Labels

Open a tab with the volume's labels.

Main Docker Compose node

Icon

Action

Description

The Deploy button

Deploy

Deploy your selected Docker Compose services using the associated run/debug configuration. For more information, refer to Docker Compose

The Stop button

Stop

Stop all containers in the selected Docker Compose services.

The Down button

Down

Stop and remove all containers in the selected Docker Compose services, including all related networks, volumes, and images.

The Edit Configuration button

Edit Configuration

Edit the selected Docker Compose run configuration.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Docker Compose services

Icon

Action

Description

The Start button

Start

Start all containers for the selected service.

The Stop button

Stop

Stop all containers for the selected service.

The Scale button

Scale

Change the number of containers for the selected service.

The Delete Container button

Delete Container

Delete the selected container.

The Filter button

Filter

Choose whether you want to show or hide containers that are not running and images with no tags.

Productivity tips

Use tabs

The Services tool window can include a lot of services, which you can group according to their type or create separate tabs for your own custom grouping. For example, you can create a tab that will include the following: the run configuration for the application that you are developing, the Docker container that runs the database used as a backend for your application, and a console for accessing the database.

Hide the services tree

Click The Show Options Menu button in the right part of the Services tool window toolbar and then click Show Services Tree to remove the checkbox. You can also press CtrlShift0T to toggle the services tree.

If you hide the services tree, it is replaced by a services navigation bar. Press AltHome to focus the services navigation bar.

Hide, remove, and delete services

Right-click any service and select Delete Delete to completely remove the corresponding run configuration, cloud provider, Docker connection, and so on.

If you don't want to show run/debug configurations of a certain type in the Services tool window, right-click the corresponding configuration and select Remove Configuration Type from Services. This will not remove the actual configuration.

To hide a specific run configuration from the Services tool window, right-click the corresponding configuration and select Hide Configuration. To see all hidden run configurations, click the Add Service menu and select Restore Hidden Configurations.