Using profiles with Compose
Docker Docs · نسخهٔ 747e4c7528c7 · CC BY 4.0 برای مستندات و مجوزهای همراه
{{% include "compose/profiles.md" %}}
Assigning profiles to services
Services are associated with profiles through the [profiles attribute](/reference/compose-file/services.md#profiles) which takes an array of profile names:
services:
frontend:
image: frontend
profiles: [frontend]
phpmyadmin:
image: phpmyadmin
depends_on: [db]
profiles: [debug]
backend:
image: backend
db:
image: mysqlHere the services frontend and phpmyadmin are assigned to the profiles frontend and debug respectively and as such are only started when their respective profiles are enabled.
Services without a profiles attribute are always enabled. In this case running docker compose up would only start backend and db.
Valid profiles names follow the regex format of [a-zA-Z0-9][a-zA-Z0-9_.-]+.
توجه: The core services of your application shouldn't be assigned profiles so they are always enabled and automatically started. Jobs also support the [profiles attribute](/reference/compose-file/jobs.md#profiles) and follow the same rules as services: a job with profiles is only active when one of its profiles is active, unless you target it with docker compose run.
Start specific profiles
To start a specific profile supply the --profile command-line option or use the [COMPOSE_PROFILES environment variable](environment-variables/envvars.md#compose_profiles):
$ docker compose --profile debug up$ COMPOSE_PROFILES=debug docker compose upBoth commands start the services with the debug profile enabled. In the previous compose.yaml file, this starts the services db, backend and phpmyadmin.
Start multiple profiles
You can also enable multiple profiles, e.g. with docker compose --profile frontend --profile debug up the profiles frontend and debug will be enabled.
Multiple profiles can be specified by passing multiple --profile flags or a comma-separated list for the COMPOSE_PROFILES environment variable:
$ docker compose --profile frontend --profile debug up$ COMPOSE_PROFILES=frontend,debug docker compose upIf you want to enable all profiles at the same time, you can run docker compose --profile "*".
Auto-starting profiles and dependency resolution
When you explicitly target a service on the command line that has one or more profiles assigned, you do not need to enable the profile manually as Compose runs that service regardless of whether its profile is activated. This is useful for running one-off services or debugging tools.
Only the targeted service (and any of its declared dependencies via depends_on) is started. Other services that share the same profile will not be started unless:
- They are also explicitly targeted, or
- The profile is explicitly enabled using
--profileorCOMPOSE_PROFILES.
When a service with assigned profiles is explicitly targeted on the command line its profiles are started automatically so you don't need to start them manually. This can be used for one-off services and debugging tools. As an example consider the following configuration:
services:
backend:
image: backend
db:
image: mysql
db-migrations:
image: backend
command: myapp migrate
depends_on:
- db
profiles:
- tools# Only start backend and db (no profiles involved)
$ docker compose up -d
# Run the db-migrations service without manually enabling the 'tools' profile
$ docker compose run db-migrationsIn this example, db-migrations runs even though it is assigned to the tools profile, because it was explicitly targeted. The db service is also started automatically because it is listed in depends_on.
If the targeted service has dependencies that are also gated behind a profile, you must ensure those dependencies are either:
- In the same profile
- Started separately
- Not assigned to any profile so are always enabled
توجه: A profiled service that you only ever start with docker compose run, such as db-migrations above, is often better expressed as a job. Compose doesn't record whether that work succeeded once its container is removed, and nothing runs it on a schedule. A job keeps a run record with its exit code, and Docker Engine can fire it on a cron schedule. Jobs are experimental.
Stop application and services with specific profiles
As with starting specific profiles, you can use the --profile command-line option or use the [COMPOSE_PROFILES environment variable](environment-variables/envvars.md#compose_profiles):
$ docker compose --profile debug down$ COMPOSE_PROFILES=debug docker compose downBoth commands stop and remove services with the debug profile and services without a profile. In the following compose.yaml file, this stops the services db, backend and phpmyadmin.
services:
frontend:
image: frontend
profiles: [frontend]
phpmyadmin:
image: phpmyadmin
depends_on: [db]
profiles: [debug]
backend:
image: backend
db:
image: mysqlif you only want to stop the phpmyadmin service, you can run
$ docker compose down phpmyadminor
$ docker compose stop phpmyadminتوجه: Running docker compose down only stops backend and db.
Reference information
[profiles](/reference/compose-file/services.md#profiles)