Skip to content

Commit 84ee416

Browse files
committed
ENGDOCS-2341
1 parent 548f411 commit 84ee416

File tree

6 files changed

+122
-97
lines changed

6 files changed

+122
-97
lines changed

_vale/config/vocabularies/Docker/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ Zsh
113113
[Nn]amespace
114114
[Oo]nboarding
115115
[Pp]aravirtualization
116+
[Pp]repend
116117
[Pp]rocfs
117118
[Pp]roxied
118119
[Pp]roxying

content/manuals/compose/how-tos/environment-variables/envvars.md

Lines changed: 57 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,14 @@ Compose already comes with pre-defined environment variables. It also inherits c
1313

1414
This page contains information on how you can set or change the following pre-defined environment variables if you need to:
1515

16-
- `COMPOSE_CONVERT_WINDOWS_PATHS`
16+
- `COMPOSE_PROJECT_NAME`
1717
- `COMPOSE_FILE`
1818
- `COMPOSE_PROFILES`
19-
- `COMPOSE_PROJECT_NAME`
20-
- `DOCKER_CERT_PATH`
21-
- `COMPOSE_PARALLEL_LIMIT`
19+
- `COMPOSE_CONVERT_WINDOWS_PATHS`
20+
- `COMPOSE_PATH_SEPARATOR`
2221
- `COMPOSE_IGNORE_ORPHANS`
2322
- `COMPOSE_REMOVE_ORPHANS`
24-
- `COMPOSE_PATH_SEPARATOR`
23+
- `COMPOSE_PARALLEL_LIMIT`
2524
- `COMPOSE_ANSI`
2625
- `COMPOSE_STATUS_STDOUT`
2726
- `COMPOSE_ENV_FILES`
@@ -69,56 +68,71 @@ See also the [command-line options overview](/reference/cli/docker/compose/_inde
6968
Specifies the path to a Compose file. Specifying multiple Compose files is supported.
7069

7170
- Default behavior: If not provided, Compose looks for a file named `compose.yaml` or `docker-compose.yaml` in the current directory and, if not found, then Compose searches each parent directory recursively until a file by that name is found.
72-
- Default separator: When specifying multiple Compose files, the path separators are, by default, on:
73-
* Mac and Linux: `:` (colon),
74-
* Windows: `;` (semicolon).
75-
76-
The path separator can also be customized using `COMPOSE_PATH_SEPARATOR`.
71+
- When specifying multiple Compose files, the path separators are, by default, on:
72+
- Mac and Linux: `:` (colon)
73+
- Windows: `;` (semicolon)
74+
For example:
7775

78-
Example: `COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml`.
76+
```console
77+
COMPOSE_FILE=docker-compose.yml:docker-compose.prod.yml
78+
```
79+
The path separator can also be customized using [`COMPOSE_PATH_SEPARATOR`](#compose_path_separator).
7980

8081
See also the [command-line options overview](/reference/cli/docker/compose/_index.md#command-options-overview-and-help) and [using `-f` to specify name and path of one or more Compose files](/reference/cli/docker/compose/_index.md#use--f-to-specify-name-and-path-of-one-or-more-compose-files).
8182

8283
### COMPOSE\_PROFILES
8384

84-
Specifies one or more profiles to be enabled on `compose up` execution.
85+
Specifies one or more profiles to be enabled when `docker compose up` is run.
86+
8587
Services with matching profiles are started as well as any services for which no profile has been defined.
8688

8789
For example, calling `docker compose up`with `COMPOSE_PROFILES=frontend` selects services with the
8890
`frontend` profile as well as any services without a profile specified.
8991

90-
* Default separator: specify a list of profiles using a comma as separator.
92+
If specifying multiple profiles, use a comma as separator.
93+
94+
This following example enables all services matching both the `frontend` and `debug` profiles and services without a profile.
9195

92-
Example: `COMPOSE_PROFILES=frontend,debug`
93-
This example enables all services matching both the `frontend` and `debug` profiles and services without a profile.
96+
```console
97+
COMPOSE_PROFILES=frontend,debug
98+
```
9499

95100
See also [Using profiles with Compose](../profiles.md) and the [`--profile` command-line option](/reference/cli/docker/compose/_index.md#use---profile-to-specify-one-or-more-active-profiles).
96101

97102
### COMPOSE\_CONVERT\_WINDOWS\_PATHS
98103

99104
When enabled, Compose performs path conversion from Windows-style to Unix-style in volume definitions.
100105

101-
* Supported values:
102-
* `true` or `1`, to enable,
103-
* `false` or `0`, to disable.
104-
* Defaults to: `0`.
106+
- Supported values:
107+
- `true` or `1`, to enable
108+
- `false` or `0`, to disable
109+
- Defaults to: `0`
105110

106111
### COMPOSE\_PATH\_SEPARATOR
107112

108113
Specifies a different path separator for items listed in `COMPOSE_FILE`.
109114

110-
* Defaults to:
111-
* On macOS and Linux to `:`,
112-
* On Windows to`;`.
115+
- Defaults to:
116+
- On macOS and Linux to `:`
117+
- On Windows to`;`
113118

114119
### COMPOSE\_IGNORE\_ORPHANS
115120

116121
When enabled, Compose doesn't try to detect orphaned containers for the project.
117122

118123
* Supported values:
119-
* `true` or `1`, to enable,
120-
* `false` or `0`, to disable.
121-
* Defaults to: `0`.
124+
* `true` or `1`, to enable
125+
* `false` or `0`, to disable
126+
* Defaults to: `0`
127+
128+
### COMPOSE\_REMOVE\_ORPHANS
129+
130+
When enabled, Compose automatically removes orphaned containers when updating a service or stack. Orphaned containers are those that were created by a previous configuration but are no longer defined in the current `compose.yml` file.
131+
132+
- Supported values:
133+
- `true` or `1`, to enable automatic removal of orphaned containers
134+
- `false` or `0`, to disable automatic removal. Compose displays a warning about orphaned containers instead
135+
- Defaults to: `0`
122136

123137
### COMPOSE\_PARALLEL\_LIMIT
124138

@@ -128,27 +142,27 @@ Specifies the maximum level of parallelism for concurrent engine calls.
128142

129143
Specifies when to print ANSI control characters.
130144

131-
* Supported values:
132-
* `auto`, Compose detects if TTY mode can be used. Otherwise, use plain text mode.
133-
* `never`, use plain text mode.
134-
* `always` or `0`, use TTY mode.
135-
* Defaults to: `auto`.
145+
- Supported values:
146+
- `auto`, Compose detects if TTY mode can be used. Otherwise, use plain text mode
147+
- `never`, use plain text mode
148+
- `always` or `0`, use TTY mode
149+
- Defaults to: `auto`
136150

137151
### COMPOSE\_STATUS\_STDOUT
138152

139153
When enabled, Compose writes its internal status and progress messages to `stdout` instead of `stderr`.
140154
The default value is false to clearly separate the output streams between Compose messages and your container's logs.
141155

142-
* Supported values:
143-
* `true` or `1`, to enable,
144-
* `false` or `0`, to disable.
145-
* Defaults to: `0`.
156+
- Supported values:
157+
- `true` or `1`, to enable
158+
- `false` or `0`, to disable
159+
- Defaults to: `0`
146160

147161
### COMPOSE\_ENV\_FILES
148162

149163
Lets you specify which environment files Compose should use if `--env-file` isn't used.
150164

151-
When using multiple environment files, use a comma as a separator. For example,
165+
When using multiple environment files, use a comma as a separator. For example:
152166

153167
```console
154168
COMPOSE_ENV_FILES=.env.envfile1, .env.envfile2
@@ -162,21 +176,21 @@ If `COMPOSE_ENV_FILES` is not set, and you don't provide `--env-file` in the CLI
162176
163177
When enabled, Compose displays a navigation menu where you can choose to open the Compose stack in Docker Desktop, switch on [`watch` mode](../file-watch.md), or use [Docker Debug](/reference/cli/docker/debug.md).
164178

165-
* Supported values:
166-
* `true` or `1`, to enable,
167-
* `false` or `0`, to disable.
168-
* Defaults to: `1` if you obtained Docker Compose through Docker Desktop, otherwise default is `0`.
179+
- Supported values:
180+
- `true` or `1`, to enable
181+
- `false` or `0`, to disable
182+
- Defaults to: `1` if you obtained Docker Compose through Docker Desktop, otherwise default is `0`
169183

170184
### COMPOSE\_EXPERIMENTAL
171185

172186
> Available in Docker Compose version [2.26.0](/manuals/compose/releases/release-notes.md#2260) and later, and Docker Desktop version 4.29 and later.
173187
174188
This is an opt-out variable. When turned off it deactivates the experimental features such as the navigation menu or [Synchronized file shares](/manuals/desktop/features/synchronized-file-sharing.md).
175189

176-
* Supported values:
177-
* `true` or `1`, to enable,
178-
* `false` or `0`, to disable.
179-
* Defaults to: `1`.
190+
- Supported values:
191+
- `true` or `1`, to enable
192+
- `false` or `0`, to disable
193+
- Defaults to: `1`
180194

181195
## Unsupported in Compose V2
182196

content/manuals/compose/install/_index.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,20 +43,21 @@ If you have already installed Docker Desktop, you can check which version of Com
4343
> ```
4444
> Or enable [Automatically check configuration](/manuals/desktop/settings-and-maintenance/settings.md) which will detect and fix it for you.
4545
46-
### Scenario two: Install the Compose plugin
47-
48-
If you already have Docker Engine and Docker CLI installed, you can install the Compose plugin from the command line, by either:
49-
- [Using Docker's repository](linux.md#install-using-the-repository)
50-
- [Downloading and installing manually](linux.md#install-the-plugin-manually)
46+
### Scenario two: Install the Docker Compose plugin
5147
5248
> [!IMPORTANT]
5349
>
54-
>This is only available on Linux
50+
> This is only available on Linux
5551
56-
### Scenario three: Install the Compose standalone
52+
If you already have Docker Engine and Docker CLI installed, you can install the Docker Compose plugin from the command line, by either:
53+
- [Using Docker's repository](linux.md#install-using-the-repository)
54+
- [Downloading and installing manually](linux.md#install-the-plugin-manually)
5755
58-
You can [install the Compose standalone](standalone.md) on Linux or on Windows Server.
56+
### Scenario three: Install the Docker Compose standalone
5957
6058
> [!WARNING]
6159
>
62-
>This install scenario is not recommended and is only supported for backward compatibility purposes.
60+
> This install scenario is not recommended and is only supported for backward compatibility purposes.
61+
62+
You can [install the Docker Compose standalone](standalone.md) on Linux or on Windows Server.
63+

content/manuals/compose/install/linux.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,23 @@ keywords: install docker compose linux, docker compose linux, docker compose plu
66
linux install docker-compose, linux docker compose, docker compose v2 linux, install
77
docker compose on linux
88
toc_max: 3
9-
title: Install the Compose plugin
9+
title: Install the Docker Compose plugin
10+
linkTitle: Plugin
1011
aliases:
1112
- /compose/compose-plugin/
1213
- /compose/compose-linux/
14+
weight: 10
1315
---
1416

15-
On this page you can find instructions on how to install the Compose plugin on Linux from the command line.
17+
This page contains instructions on how to install the Docker Compose plugin on Linux from the command line.
1618

17-
To install the Compose plugin on Linux, you can either:
19+
To install the Docker Compose plugin on Linux, you can either:
1820
- [Set up Docker's repository on your Linux system](#install-using-the-repository).
19-
- [Install Compose manually](#install-the-plugin-manually).
21+
- [Install manually](#install-the-plugin-manually).
2022

2123
> [!NOTE]
2224
>
23-
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Compose plugin.
24-
For Compose standalone, see [Install Compose Standalone](standalone.md).
25+
> These instructions assume you already have Docker Engine and Docker CLI installed and now want to install the Docker Compose plugin. For the Docker Compose standalone, see [Install the Docker Compose Standalone](standalone.md).
2526
2627
## Install using the repository
2728

@@ -64,9 +65,9 @@ For Compose standalone, see [Install Compose Standalone](standalone.md).
6465

6566
Where `vN.N.N` is placeholder text standing in for the latest version.
6667

67-
### Update Compose
68+
### Update Docker Compose
6869

69-
To update the Compose plugin, run the following commands:
70+
To update the Docker Compose plugin, run the following commands:
7071

7172
* For Ubuntu and Debian, run:
7273

@@ -85,21 +86,21 @@ To update the Compose plugin, run the following commands:
8586

8687
> [!NOTE]
8788
>
88-
> This option requires you to manage upgrades manually. We recommend setting up Docker's repository for easier maintenance.
89+
> This option requires you to manage upgrades manually. It is recommended that you set up Docker's repository for easier maintenance.
8990

90-
1. To download and install the Compose CLI plugin, run:
91+
1. To download and install the Docker Compose CLI plugin, run:
9192

9293
```console
9394
$ DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
9495
$ mkdir -p $DOCKER_CONFIG/cli-plugins
9596
$ curl -SL https://github.com/docker/compose/releases/download/{{% param "compose_version" %}}/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
9697
```
9798

98-
This command downloads the latest release of Docker Compose (from the Compose releases repository) and installs Compose for the active user under `$HOME` directory.
99+
This command downloads and installs the latest release of Docker Compose for the active user under `$HOME` directory.
99100

100101
To install:
101-
* Docker Compose for _all users_ on your system, replace `~/.docker/cli-plugins` with `/usr/local/lib/docker/cli-plugins`.
102-
* A different version of Compose, substitute `{{% param "compose_version" %}}` with the version of Compose you want to use.
102+
- Docker Compose for _all users_ on your system, replace `~/.docker/cli-plugins` with `/usr/local/lib/docker/cli-plugins`.
103+
- A different version of Compose, substitute `{{% param "compose_version" %}}` with the version of Compose you want to use.
103104
- For a different architecture, substitute `x86_64` with the [architecture you want](https://github.com/docker/compose/releases).
104105

105106

content/manuals/compose/install/standalone.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,66 @@
11
---
2-
title: Install Compose standalone
2+
title: Install the Docker Compose standalone
3+
linkTitle: Standalone
34
description: How to install Docker Compose - Other Scenarios
45
keywords: compose, orchestration, install, installation, docker, documentation
56
toc_max: 3
7+
weight: 20
68
---
79

8-
On this page you can find instructions on how to install Compose standalone on Linux or Windows Server, from the command line.
9-
10-
### On Linux
10+
This page contains instructions on how to install Docker Compose standalone on Linux or Windows Server, from the command line.
1111

1212
> [!WARNING]
1313
>
14-
> Note that Compose standalone uses the `-compose` syntax instead of the current standard syntax `compose`.
15-
>For example type `docker-compose up` when using Compose standalone, instead of `docker compose up`.
14+
> The Docker Compose standalone uses the `-compose` syntax instead of the current standard syntax `compose`.
15+
> For example, you must type `docker-compose up` when using Docker Compose standalone, instead of `docker compose up`.
16+
17+
## On Linux
18+
19+
1. To download and install the Docker Compose standalone, run:
1620

17-
1. To download and install Compose standalone, run:
1821
```console
1922
$ curl -SL https://github.com/docker/compose/releases/download/{{% param "compose_version" %}}/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
2023
```
24+
2125
2. Apply executable permissions to the standalone binary in the target path for the installation.
26+
2227
```console
2328
$ chmod +x /usr/local/bin/docker-compose
2429
```
25-
3. Test and execute Compose commands using `docker-compose`.
2630

27-
> [!TIP]
28-
>
29-
> If the command `docker-compose` fails after installation, check your path.
30-
> You can also create a symbolic link to `/usr/bin` or any other directory in your path.
31-
> For example:
32-
> ```console
33-
> $ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
34-
> ```
31+
3. Test and execute Docker Compose commands using `docker-compose`.
3532

36-
### On Windows Server
33+
> [!TIP]
34+
>
35+
> If the command `docker-compose` fails after installation, check your path.
36+
> You can also create a symbolic link to `/usr/bin` or any other directory in your path.
37+
> For example:
38+
> ```console
39+
> $ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
40+
> ```
41+
42+
## On Windows Server
3743
38-
Follow these instructions if you are running the Docker daemon and client directly
39-
on Microsoft Windows Server and want to install Docker Compose.
44+
Follow these instructions if you are [running the Docker daemon directly
45+
on Microsoft Windows Server](/manuals/engine/install/binaries.md#install-server-and-client-binaries-on-windows) and want to install Docker Compose.
4046
4147
1. Run PowerShell as an administrator.
42-
When asked if you want to allow this app to make changes to your device, select **Yes** in order to proceed with the installation.
48+
In order to proceed with the installation, select **Yes** when asked if you want this app to make changes to your device.
4349
44-
2. GitHub now requires TLS1.2. In PowerShell, run the following:
50+
2. Optional. Ensure TLS1.2 is enabled.
51+
GitHub requires TLS1.2 fore secure connections. If you’re using an older version of Windows Server, for example 2016, or suspect that TLS1.2 is not enabled, run the following command in PowerShell:
4552
4653
```powershell
4754
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
4855
```
49-
3. Run the following command to download the latest release of Compose ({{% param "compose_version" %}}):
56+
57+
3. Download the latest release of Docker Compose ({{% param "compose_version" %}}). Run the following command:
5058
5159
```powershell
5260
Start-BitsTransfer -Source "https://github.com/docker/compose/releases/download/{{% param "compose_version" %}}/docker-compose-windows-x86_64.exe" -Destination $Env:ProgramFiles\Docker\docker-compose.exe
5361
```
54-
To install a different version of Compose, substitute `{{% param "compose_version" %}}` with the version of Compose you want to use.
62+
63+
To install a different version of Docker Compose, substitute `{{% param "compose_version" %}}` with the version of Compose you want to use.
5564
5665
> [!NOTE]
5766
>

0 commit comments

Comments
 (0)