Docker compose run configuration

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, PhpStorm suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and PhpStorm stores run configuration settings in .idea/workspace.xml.

Server

Select the Docker daemon connection to use for the run configuration.

Compose files

Specify the compose files that define the necessary services. Docker Compose builds the configuration in the specified order, so any subsequent files override and add to the fields of the same service in previous files.

This is similar to using the -f option with the docker compose command.

Services

Specify the services to build, create, and start.

Click to select services that are listed in the YML file.

Before launch

Specify a list of tasks to perform before starting the run configuration. For example, run another configuration, build the necessary artifacts, run some external tool or a web browser, and so on.

Click or press Alt+Insert to add one of the available tasks.

Move tasks in the list using and to change the order in which to perform the tasks. Select a task and click to edit the task. Click to remove the selected task from the list.

Show this page

Show the run configuration settings before actually starting it.

Activate tool window

Depending on the type of configuration, open the Run, Debug, or Services tool window when you start this run configuration. If this option is disabled, you can open the tool window manually:

• View | Tool Windows | Run or Alt+4

• View | Tool Windows | Debug or Alt+5

• View | Tool Windows | Services or Alt+8

Project name

Specify an alternate project name for Docker Compose. By default, it is the name of the current directory.

This is similar to using the -p option with the docker compose command.

Environment variables

Specify the Docker Compose environment variables. These are used only by the Docker Compose process. They are not passed on to any of the containers.

Environment variables file

Specify the path to a custom environment file that defines the Docker Compose environment variables.

This is similar to using the --env-file option with the docker compose command.

By default, the Docker Compose run configuration looks for a file named .env in the directory with the Docker Compose file.

Enable BuildKit

Use the BuildKit backend when building the images.

This is similar to setting the DOCKER_BUILDKIT=1 environment variable when invoking the docker build command.

Remove volumes on `down

When stopping and removing containers, also delete named volumes declared in the Docker Compose file and anonymous volumes attached to containers.

This is similar to using the -v or --volumes option with the docker compose down command.

Enable compatibility mode

Convert v3 service definitions into v2 compatible parameters.

This is similar to using the --compatibility option with the docker compose command.

Remove images on `down

Configure which images should be removed when stopping and removing containers. You can choose to remove all images used by any service or only images that don't have a custom tag set in the image field.

This is similar to using the --rmi option with the docker compose down command.

Timeout

Set a timeout in seconds to forcefully terminate containers that won't shutdown gracefully.

Docker usually tries to gracefully terminate any container with SIGTERM, but it might end up running indefinitely. Set a timeout after which Docker should send SIGKILL to force the shutdown.

This is similar to using the -t or --timeout option with the docker compose up command.

Exit code

Return the exit code of the selected service container.

Whenever a container in the selected service stops, return its exit code and stop all other containers in the service.

This is similar to using the --exit-code-from option with the docker compose up command.

Override scale

Set the number of containers to start for each service.

This option overrides the scale parameter in the Docker Compose file, if it's present.

This is similar to using the --scale option with the docker compose up command.

Recreate dependencies

Recreate dependent containers when starting a service.

This is similar to using the --always-recreate-deps option with the docker compose up command.

Recreate anonymous volumes

Recreate anonymous volumes instead of retrieving data from the previous containers.

This is similar to using the -V or --renew-anon-volumes option with the docker compose up command.

Remove orphans

Remove containers for services not defined in the Docker Compose file.

This is similar to using the --remove-orphans option with the docker compose up command.

Start

Configure which services to start:

• Selected and dependencies: By default, Docker Compose starts all of the specified services and linked services.

• None: Don't start any services after creating them. This is similar to using the --no-start option with the docker compose up command.

• Selected services: Don't start any of the linked services. This is similar to using the --no-deps option with the docker compose up command.

Attach to

Configure for which containers to show output streams:

• Selected services: By default, Docker Compose attaches to all started containers of the specified services.

• None: Don't attach to any containers. This is similar to using the -d or --detach option with the docker compose up command.

• Selected and dependencies: Attach to containers of the specified services and linked services. This is similar to using the --attach-dependencies option with the docker compose up command.

Recreate containers

Configure which containers to stop and replace by new ones:

• Changed configuration: By default, Docker Compose recreates containers only if the corresponding configuration or image has changed.

• All: Recreate all containers in the services, even if the corresponding configuration or image hasn't changed. This is similar to using the --force-recreate option with the docker compose up command.

• None: Don't recreate any containers in the services, even if the corresponding configuration has changed. This is similar to using the --no-recreate option with the docker compose up command.

Build

Configure which images to build before starting containers:

• Only missing images: By default, Docker Compose only builds images that are not available and uses previously built ones when possible.

• Never: Don't build any images. Always use previously built images or throw an error if some image is not available. This is similar to using the --no-build option with the docker compose up command.

• Always: Always build images before starting containers. This is similar to using the --build option with the docker compose up command.

Stop Containers

Configure how to stop containers in a service. By default, Docker Compose doesn't stop other containers in a service. You have to stop them manually.

However, you can choose to stop all containers if any container in a service stops. This is similar to using the --abort-on-container-exit option with the docker compose up command.