1
0
mirror of https://github.com/docker/docs.git synced 2026-10-25 06:09:46 +03:00
Commit Graph

181 Commits

Author SHA1 Message Date
plowward
a5b2e86eea docs(compose): fix indentation in Step 6 infra.yaml example (#25985)
The `infra.yaml` code block under Step 6 (Structure your project with
multiple Compose files) was nested inside an ordered list, which left
stray leading whitespace on `services:` and `volumes:`. When users
copy-paste the example verbatim, `docker compose` fails with:

go-yaml load error in parser at L13.C1: did not find expected <document
start>

This change aligns the YAML with the standard 0/2/4-space indent used
elsewhere in the tutorial, and also normalizes the leading whitespace of
the surrounding code fence.

<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-09-01 09:53:27 +01:00
Allie Sadler
9fae1ff731 Compose image digest (#25889)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-08-19 07:22:54 -05:00
Dean Chen
f3f734abe7 docs: clarify modelRunner.enabled replica vs host DMR (#25767)
The Compose Bridge Model Runner page said `enabled: false` means “no
Docker Model Runner resources are deployed,” which clashes with the
Desktop section that still points workloads at the host Model Runner.

Clarified that the zero-replica note is only about the in-cluster
deployment.

Fixes #25485

Signed-off-by: Dean Chen <862469039@qq.com>
2026-08-18 14:46:20 +01:00
Dean Chen
535871964a docs: stop calling network_mode a Compose network driver
The default-network paragraph pointed "use a different driver" at
network_mode (host/none/service). That's the container network stack,
not the Compose network driver.

Signed-off-by: Dean Chen <862469039@qq.com>
2026-08-16 13:47:16 +05:00
mickey-mikey
b93acc3520 compose: note that secrets require Linux containers (#25541)
### Description

Adds a NOTE callout to the Compose secrets guide stating that secrets
are supported on Linux containers only, with the reason.

The page states secrets are delivered as a bind mount at
`/run/secrets/<secret_name>`, with no platform caveat. On Windows
containers this fails at container creation:

```
invalid mount config for type "bind": source path must be a directory
```

Windows containers can't bind-mount a single file, only directories — a
platform limitation confirmed by maintainers in moby/moby#37120 and
docker/cli#2055. Because Compose secrets are single-file bind mounts,
they can't work on Windows containers.

Tested on a Windows Server 2025 container
(`mcr.microsoft.com/windows/server:ltsc2025`), Hyper-V isolation, Docker
29.6.1, Compose v2.

Fixes #25540

### Related issues or tickets

- #25540
- moby/moby#37120
- docker/cli#2055

### Reviews

- [ ] Technical review
- [ ] Editorial review
2026-08-13 11:54:20 +01:00
Harsh Dhar Agarwal
97a5bbdd16 Merge pull request #25642 from hd-agarwal/fix/docker-file-comments-issue
Fixes Dockerfile build failing due to comments on same line as instructions
2026-07-24 17:04:13 +02:00
Niels Kaspers
b5af1d2a88 docs: mention Compose v5 in FAQ (#25530)
## Description

Clarify that Compose v5 uses the same Docker Compose CLI command and is
functionally identical to Compose v2. Link to the existing Go SDK
documentation for the primary distinction.

## Related issues or tickets

Closes #25529

## Reviews

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-07-10 11:31:27 +01:00
Allie Sadler
159fa357d8 Compose: init containers (#25435)
<!--Delete sections as needed -->

## Description

As per https://github.com/docker/compose/pull/13862 and
https://github.com/compose-spec/compose-spec/pull/647

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2026-07-02 12:44:12 +01:00
Mickael Emirkanian
f36bf72641 compose: add another field to trust model table (#25425)
## Description

Follow-up to #25414 - While the list is non-exhaustive, provide another
field in the table
2026-06-24 08:33:13 +01:00
Mickael Emirkanian
4bcf3b6162 docs(compose): clarify reads (#25414)
Updates the trust model to clarify read operation during config and
other read-only calls

## Reviews

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2026-06-23 08:02:59 +01:00
Allie Sadler
f1c44df2cd docs triage (#25410)
<!--Delete sections as needed -->

## Description

Fixes https://github.com/docker/docs/issues/25400
Fixes https://github.com/docker/docs/issues/25399
Fixes https://github.com/docker/docs/issues/25281
Fixes https://github.com/docker/docs/issues/25320 and replaces
https://github.com/docker/docs/pull/25394

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-06-22 15:34:18 +01:00
Allie Sadler
2751e99876 Compose: env variable clarification (#25398)
<!--Delete sections as needed -->

## Description

Closes https://github.com/docker/docs/issues/25337

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: aevesdocker <allie.sadler@docker.com>
2026-06-19 16:15:55 +01:00
Allie Sadler
f0e4e47901 redirect tidy (#25115)
<!--Delete sections as needed -->

## Description

As per Craigs number-crunching, this PR removes some vvvvv old and
unused redirects 🧹

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-05-28 14:39:44 +01:00
James Kerrane
bd8b8ce7cd Improve style, grammatical fix (#25112)
Improves style, fixes a grammatical issue in `trust-model.md`.
2026-05-20 07:44:08 +01:00
David Karlsson
322a7cf2e8 Merge pull request #25051 from dvdksn/heroicons
chore: migrate icons from Material Symbols to Heroicons
2026-05-19 05:47:50 +02:00
David Karlsson
ee71c80562 chore: migrate icons from Material Symbols to Heroicons
Replaces @material-symbols/svg-400 (5.5 MB) with heroicons (488 KB) — an
11x reduction in icon asset size. Heroicons uses a single consistent
distribution format (24px solid SVGs, fill="currentColor") eliminating
the need for the separate utils/svg.html partial, the icon-svg-stroke CSS
utility, and the dual-path resolution logic in icon.html.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-18 12:05:54 +02:00
Allie Sadler
80faf488d2 Compose issue triage (#25060)
<!--Delete sections as needed -->

## Description

Closes https://github.com/docker/docs/issues/25035
Replaces and closes https://github.com/docker/docs/pull/24650
Closes https://github.com/docker/docs/issues/24853
Replaces and closes https://github.com/docker/docs/pull/24866
Closes https://github.com/docker/docs/issues/23678
Closes https://github.com/docker/docs/pull/24812
Replaces and closes https://github.com/docker/docs/pull/23816

Verified against the Compose code base
## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-05-14 15:16:53 +01:00
Usha Mandya
9936e9387c Merge pull request #25010 from usha-mandya/product-buckets
Update side nav to reflect current product groupings
2026-05-11 14:11:34 +01:00
Usha Mandya
997b3b5f90 update side nav groups
Signed-off-by: Usha Mandya <usha.mandya@docker.com>
2026-05-11 13:36:30 +01:00
Allie Sadler
563667a0c2 Gro 109 (#24961)
<!--Delete sections as needed -->

## Description

Compose networking refresh

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-05-08 14:59:40 +01:00
Rohan Santhosh Kumar
978ff6808e Fix wording in Compose extends docs (#24701)
## Summary
Fix wording in the Compose extends documentation by changing `re-use` to
`reuse`.

## Related issue
N/A

## Guideline alignment
Single-file documentation wording fix with no behavior change.

## Validation
Not run locally; documentation-only change.

Co-authored-by: Codex <codex@openai.com>
2026-04-13 07:34:46 +01:00
Allie Sadler
667ab62639 Compose security (#24601)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-04-02 14:15:42 +01:00
Ilya Grigoriev
74564fc9fb Update lifecycle.md
Swapped the parameters for `chown` command
2026-03-27 20:08:49 +03:00
Rohan Santhosh Kumar
c454cbb95e docs: update Compose reuse wording (#24513)
## Description
- Update the Compose features page to use `reuse`/`Reusing` instead of
the hyphenated forms.

## Related issues or tickets
- N/A (trivial docs wording fix)

## Reviews
- [ ] Technical review
- [x] Editorial review
- [ ] Product review

## Guideline alignment
- Reviewed `CONTRIBUTING.md` and the PR template before editing.
- Kept the diff to one documentation file with no behavior changes.

## Validation
- Not run (docs-only wording change).

---------

Co-authored-by: rohan436 <rohan.santhoshkumar@googlemail.com>
2026-03-25 09:35:10 +00:00
David Karlsson
6b1ebe4fba Merge pull request #24420 from dvdksn/fix/issue-24387-compose-standalone-clarity
compose: clarify standalone install warning with recommended alternatives
2026-03-19 12:29:57 +01:00
David Karlsson
2388e9ea06 compose: clarify standalone install warning with recommended alternatives
The existing warning says standalone is "not recommended" but gives
no guidance on what to use instead. Add links to Docker Desktop and
the Compose plugin as the preferred alternatives, and clarify that
standalone is only appropriate when neither option is available.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-19 10:38:06 +00:00
Allie Sadler
13a1e4487c Compose: Bridge for orgs (#24056)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-03-16 10:40:04 +00:00
Geetansh2842
529da2dcf9 docs: clarify Model Runner template customization (#24333) (#24351)
Add common scenarios (GPU scheduling, storage sizing, service exposure,
policy alignment) to guide customization choices.
Related issues or tickets
Fixes #24333

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2026-03-16 10:39:42 +00:00
github-actions[bot]
1457fb4ecb docs: address issue #24343 (#24345)
## Summary
Updated Compose production readiness language to use present-tense
framing instead of stale time-relative language.

## Changes
- Replaced "has traditionally been focused on development and testing
workflows, but with each release we're making progress on more
production-oriented features" with present-tense language that
accurately reflects Compose's current production capabilities
- Changed from developer perspective ("we're making progress") to
user-focused language
- Removed suggestion that Compose is still becoming production-ready

Fixes #24343

---
🤖 Generated with [Docker Agent](https://github.com/docker/docker-agent)

Co-authored-by: aevesdocker <102604716+aevesdocker@users.noreply.github.com>
2026-03-12 09:32:42 +00:00
github-actions[bot]
3191bd5fe3 docs: address issue #24344 (#24346)
## Summary
Fixed inconsistent version reference in Compose history documentation to
mention both v2 and v5.

## Changes
- Updated statement about Compose file format 1 compatibility to
reference both Compose v2 and v5 instead of only v2, making it
consistent with the document's scope

Fixes #24344

---
🤖 Generated with [Docker Agent](https://github.com/docker/docker-agent)

Co-authored-by: aevesdocker <102604716+aevesdocker@users.noreply.github.com>
2026-03-12 09:29:55 +00:00
Allie Sadler
49b049a688 Compose quickstart refresh (#24221)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-03-09 16:00:22 +00:00
David Karlsson
c5b3cb60ad chore: fix links pointing to redirect targets
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-24 08:01:08 +01:00
David Karlsson
70d0c07c69 site: use content adapters for cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-24 08:01:05 +01:00
github-actions[bot]
3c0930598d docs: address issue #24158 (#24159)
## Summary
Changed `build: alpine` to `build: ./alpine` in extends examples to
clarify it's a directory path, not an image name.

## Changes
- Updated two examples in extends documentation to use `build: ./alpine`
instead of `build: alpine` to avoid confusion with the Alpine Docker
image

Fixes #24158

---
🤖 Generated with [cagent](https://github.com/docker/cagent)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-02-18 10:36:35 +00:00
Allie Sadler
8e963e52bf Compose badge tidyup (#24057)
<!--Delete sections as needed -->

## Description

Removes 'new' badges for items that are no longer new

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-02-02 15:10:51 +00:00
Allie Sadler
0f8cb36493 ENGDOCS-3136 (#23939)
<!--Delete sections as needed -->

## Description

Updates Compose history and development page with v5 info

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-01-08 07:33:28 +00:00
Allie Sadler
3415afac40 ENGDOCS-3132 (#23934)
<!--Delete sections as needed -->

## Description

As discussed before xmas, we will be removing opensource release note
pages and pointing users directly to the GitHub page

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-01-07 07:13:56 +00:00
Allie Sadler
df6b585352 ENGDOCS-3131 (#23930)
<!--Delete sections as needed -->

## Description

Part of the discussions with Compose team at the offsite, we agreed to
remove the migration page as we now have v5 and v1 stopped receiving
support 4 years ago. Visits to this page are minimal. Redirects are to
the main Compose landing page now and Vale error is to vvv old Desktop
release pages that are no longer visible

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-01-06 09:54:51 +00:00
Allie Sadler
920679726a ENGDOCS-3133 (#23931)
<!--Delete sections as needed -->

## Description

Removes the redundant sample apps page in the Compose docs, as per
discussions with the Compose team.
This page isn't really visited and it includes content that links to
other Compose docs pages. The link to the sample apps repo is better
served on other pages such as the quickstart tutorial. Redirects to the
Quickstart page

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-01-06 09:51:45 +00:00
Nicolas De loof
f2633dabdc compose 5.0.1 (#23868)
## Description

Note: I can't run `hugo mod vendor`:

```
$ hugo mod vendor 
WARN  deprecated: the ":slugorfilename" permalink token was deprecated in Hugo 0.144.0 and will be removed in a future release. Use ":slugorcontentbasename" instead.
Error: html/template:redirect/single.html:1:13: no such template "_internal/alias.html"
```

## Related issues or tickets

## Reviews

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-12-18 15:51:00 +00:00
Guillaume Lours
a4b77bfdc7 add missing 'direct path' to provider 'type' attribute definition (#23813)
<!--Delete sections as needed -->

## Description
Add the 3rd option allowing to pass a direct path to configure
`provider.type` attribute

## Related issues or tickets
N/A

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [x] Editorial review
- [ ] Product review

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Nicolas De loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-12-05 08:43:01 +00:00
David Karlsson
64afb7e42d Merge pull request #23800 from dvdksn/update-pgdata-path
chore: change mount path to work with postgres:18
2025-12-04 22:00:51 +01:00
Allie Sadler
1da94b143e compose sdk: release follow-up (#23803)
<!--Delete sections as needed -->

## Description

Follow-up to https://github.com/docker/docs/pull/23802

- moves major new release to new release notes page
- adds the Compose SDK page 

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-12-04 13:35:21 +00:00
David Karlsson
0220ef6745 chore: change mount path to work with postgres:18
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-12-04 11:08:14 +01:00
Nicolas De loof
90bbaacaa5 Docker Compose v5 (#23802)
## Description

Docker Compose v5

## Related issues or tickets

## Reviews

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2025-12-03 13:25:29 +00:00
David Karlsson
0ff924b333 engine: consolidate network drivers documentation
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-21 19:51:11 +01:00
Vedran Pavic
c7af427359 Update control startup example (#23668)
## Description

This PR updates control startup example to prevent Compose from
interpolating values intended as shell command arguments.

Current example yields the following warnings:

```bash
WARN[0000] The "POSTGRES_USER" variable is not set. Defaulting to a blank string. 
WARN[0000] The "POSTGRES_DB" variable is not set. Defaulting to a blank string. 
```

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-11-10 11:45:54 +00:00
Guillaume Lours
24ca6ef7aa release-notes for Compose v2.40.3 version (#23629)
<!--Delete sections as needed -->

## Description
Add release notes of latest `v2.40.3` version of Compose

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [x] Editorial review
- [ ] Product review

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-11-03 10:54:34 +00:00
Adam Monsen
610f6995ad Merge pull request #23633 from meonkeys/yaml-ish-envfile
document yaml-ish .env file syntax and spacing rules
2025-11-03 11:10:39 +01:00
Abdul Baari Davids
fa1b51488a Fix typo in Compose Bridge documentation (#23640)
This pull request corrects a minor typo in the Compose Bridge
documentation to improve clarity.

- Documentation:
* Fixed a typo in the description of the Compose Bridge feature in
`content/manuals/compose/bridge/_index.md` ("geneterates" →
"generates").
2025-11-03 09:50:17 +00:00