1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00

80 Commits

Author SHA1 Message Date
David Karlsson
d511fb5636 docs: move AI Compose and MCP docs into product sections (#26180)
Baby step towards cleaning up the sidenav for the ai/agents section.

<img width="306" height="304" alt="image"
src="https://github.com/user-attachments/assets/57ebd1df-9c7f-4ee8-a84f-a61ffec2cd90"
/>


Moves “Use AI models in Compose” into Compose → How-tos and MCP Catalog
and Toolkit into Docker Desktop → Features and capabilities, removing
both entries from the top-level AI and agents sidebar group.

Updates internal source links and preserves existing public URLs. Scoped
lint and a Hugo build passed; rendered sidebar ancestry, MCP page URLs,
and images were checked locally.

Generated by Codex
2026-09-25 11:42:07 +02:00
Dean Chen
d105e549db docs: say build.network is a mode, not a Compose network (#25881)
build.network was showing `custom_network_1`, which looks like a
user-defined Compose network. it's the RUN networking mode (`default` /
`none` / `host`), same as `docker build --network`.

@netlify /reference/compose-file/build/

Fixes #21982

Signed-off-by: Dean Chen <862469039@qq.com>
2026-08-26 10:49:38 +01:00
Dean Chen
c44db82915 docs: say the host, not the host container, has swap
Memory-swap fallback is about the Docker host's swap, not a container.

Signed-off-by: Dean Chen <862469039@qq.com>
2026-08-16 19:39:24 +05:00
Allie Sadler
6bdcc9db99 spec clarifications (#25601)
<!--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-07-20 13:35:35 +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
David Karlsson
f62d925a50 docs: remove unused includes and fix broken include references
Delete 10 orphaned files under content/includes that are no longer
referenced by any page via the include shortcode:

- aci-ecs-eol.md, compose-eol.md, dev-envs-changing.md,
  dockerfile-labs-channel.md (stale EOL/status callouts)
- buildx-v0.10-disclaimer.md, experimental.md, deploy.md,
  guides-get-docker.md, open-terminal.md (orphaned snippets)
- labspace-quickstart.md (empty)

Also fix two broken include references:

- scout-early-access.md was deleted in 737ad3c4be but two environment
  integration pages still included it; remove the dangling lines.
- reference/compose-file/develop.md included compose/develop.md, which
  does not exist; point it at the real file, compose/services-develop.md.

Every include file is now referenced, and every reference resolves.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-18 11:06:11 +02: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
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
Mahitha Adapa
1ad73ff812 Add network_mode: bridge to Compose file reference (#24749)
<!--Delete sections as needed -->

## Description

Adds documentation for `network_mode: bridge` in the Compose file
reference.

While `bridge` is a valid and functional network_mode option that
connects
containers to the host's default bridge network, it was not documented
alongside the other options (none, host, service, container).

Fixes #24742.

- #24742

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

## Reviews

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

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

---------

Signed-off-by: Mahitha Adapa <mahitha.ada@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2026-04-20 14:48:44 +01:00
Mohith shuka
92194c26c9 Fixes https://github.com/docker/docs/issues/23958 (#24393)
The `security_opt` field in the Compose services reference did not
document
the accepted syntax variants, which was confusing for users.

Added a note explaining that options accept `option=value`,
`option:value`,
or bare `option` syntax (for booleans). Added examples showing all three
equivalent forms for `no-new-privileges`.
2026-04-20 14:35:37 +01:00
Chubiyojo Adejoh
21f548fc6a Update ports section in services.md (#22368)
Explicitly state the dangers if a port mapping binds to all interfaces

## Description

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

We recently discovered that docker was bypassing our firewall rules when
forwarding ports from a container using the standard `<host
port>:<container port>` syntax. What this meant was that the container
was effectively visible to the entire internet. It was only after some
digging did we discover that it is possible and even recommended to
explicitly bind the host port to localhost so it doesn't accept
connections from everywhere. This PR updates the docs to explicitly
state the potential dangers of not specifying a localhost when exposing
docker container ports.

## Reviews

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

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2026-04-14 10:55:45 +01:00
David Karlsson
2c0dd7e083 chore: update references to docker vscode extension
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-03-09 12:39:05 +01:00
David Karlsson
cbceafed09 docs: address issue #24163 (#24177)
## Summary
Removed repeated text about path behavior in the Compose Build
Specification documentation.

## Changes
- Consolidated duplicate sentences about absolute/relative path behavior
that appeared in both the "former case" and "latter case" paragraphs
- Improved clarity by explicitly referencing "When `build` is specified
as a string" and "When `build` is specified as a detailed structure"
instead of vague "former/latter" references
- Added a single consolidated paragraph explaining path behavior that
applies to both cases

Fixes #24163

---
🤖 Generated with [cagent](https://github.com/docker/cagent)
2026-02-27 13:22:53 +00: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
Quinn Redwoods
120b064895 docs: clarify depends_on short syntax does not wait for healthy services (#24144)
## Description

Clarifies that the `depends_on` short syntax does not wait for services
to become healthy, and waits only for them to be started (running).

This aligns with the long syntax section, which defines
`service_started` as equivalent to the short syntax, and with the
[Control startup and shutdown
order](https://docs.docker.com/compose/how-tos/startup-order/#control-startup)
manual:

> On startup, Compose does not wait until a container is "ready", only
until it's running.

Confirmed locally that short syntax behaves equivalently to `condition:
service_started`.

## Related issues or tickets

None

## Reviews

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

- [x] Technical review
- [x] Editorial review
- [ ] Product review
2026-02-17 14:57:47 +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
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
Antoine C
ab47fa4ee7 docs: use == operator in node.labels constraint (#23522)
## Description

https://docs.docker.com/reference/compose-file/deploy/#placement

In this section, `node.labels` must be specified. Also, it must be `==`
and not a simple `=`, an error occurs without it:

```bash
failed to update service myapp_redis: Error response from daemon: rpc error: code = Unknown desc = constraint expected one operator from ==, !=
```
2025-11-27 09:45:27 +00:00
David Karlsson
9fe8e768d1 lint: add MD059/descriptive-link-text markdownlint rule
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:10 +01: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
Allie Sadler
9ab55eb18f compose: spec update (#23580)
<!--Delete sections as needed -->

## Description

https://github.com/compose-spec/compose-spec/pull/618

## 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-10-20 12:11:33 +01:00
Allie Sadler
df185b501a Compose volume clarity (#23531)
<!--Delete sections as needed -->

## Description

addresses
https://docker.slack.com/archives/C04BMTUC41E/p1759908356837639

## 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-10-09 10:28:44 +01:00
Guillaume Lours
7fbf498277 add description of 'initial_sync' attribute in Compose watch documentation (#23421)
<!--Delete sections as needed -->

## Description
Describe the new added `initial_sync` attribute of Compose watch
configuration

## Related issues or tickets
Fix #23345

## 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: aevesdocker <allie.sadler@docker.com>
2025-09-18 10:54:30 +01:00
bri
021536bcdb Enhance examples in reference/compose-file/configs (#23185)
## Description

Reworked docker-compose configs examples slightly
2025-09-08 10:28:49 +01:00
Allie Sadler
4cc42b22ab Compose: pull_policy update (#23371)
<!--Delete sections as needed -->

## Description

adds https://github.com/compose-spec/compose-spec/pull/612

## 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-09-08 08:57:39 +01:00
Allie Sadler
49771bafee ENGDOCS-2944 (#23311)
<!--Delete sections as needed -->

## Description

Fixes https://github.com/docker/docs/issues/23160
Fixes https://github.com/docker/docs/issues/23051

## 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-08-26 16:06:49 +01:00
Allie Sadler
078cf597c0 minor spec updates (#23213) 2025-08-08 08:17:09 +01:00
Allie Sadler
83d589d2de build attributes (#23149)
<!--Delete sections as needed -->

## Description

https://github.com/docker/docs/pull/23148/files

## 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-07-24 13:27:56 +01:00
Arthur
7193d2a882 chore: reduce noice in Vale error reporting (#23146)
Exclude extra release notes from Spelling/Term checks.
Exclude `<a>` from checks.
Add new terms and fix some double space errors.

- Before: 2691
- After: 967
2025-07-24 11:04:55 +02:00
Allie Sadler
479885a3d8 Compose:fix attach and link to models page (#23121)
<!--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
2025-07-21 10:29:39 +01:00
Allie Sadler
4c6f75f19f Compose spec freshness (#23029)
<!--Delete sections as needed -->

## Description
 
Voila

## 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-07-09 15:17:42 +01:00
Arthur
be57eec723 fix: code block (#23022) 2025-07-08 06:53:18 +02:00
Allie Sadler
6c5ecca0a4 Engdocs 2795 (#22961)
<!--Delete sections as needed -->

## Description

Adds Compose 2.38 content (includes some of the WAD updates - more
incoming)

## 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-07-01 10:19:17 +01:00
Allie Sadler
7b181005c3 Merge pull request #22882 from aevesdocker/ENGDOCS-2753
Compose: Spec attribute
2025-06-23 16:56:22 +01:00
bri
d84f2245e3 Merge pull request #22662 from b-/patch-1
Remove quotes from octal value in reference/compose-file/services.md
2025-05-27 08:06:40 +01:00
Allie Sadler
4fd64ac50b Compose: spec updates (#22655)
<!--Delete sections as needed -->

## Description

Spec updates on the new attributes released last week (plus some extra -
adds https://github.com/docker/compose/pull/12769 )

## 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-05-16 14:24:04 +01:00
Allie Sadler
12698a8d47 ENGDOCS-2553 (#22413)
<!--Delete sections as needed -->

## Description

Adds new `volume.type=image` to the spec

## Related issues or tickets

https://github.com/compose-spec/compose-spec/pull/585/files

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-04-11 16:08:30 +01:00
Allie Sadler
11e8cb3925 Merge pull request #22408 from aevesdocker/ENGDOCS-2549
ENGDOCS-2549
2025-04-11 08:11:39 +01:00
yinzhidong
7d8c6f14f3 update services.md (#22329)
<!--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
2025-03-31 08:45:24 +01:00
Bokyeom
7c9f78cda8 Fix typos and align with Docker/Compose specs (#22328)
## Description
- Fixed minor typos like `msyql`, `model`, `.json|`.
- Although `docker remove` works due to CLI fallback, it's not an
official command. Replaced with `docker rm` for correctness and clarity.
- Replaced `docker-compose.yml` with `compose.yaml` to align with the
[Compose
specification.](https://github.com/compose-spec/compose-spec/blob/main/03-compose-file.md)
2025-03-31 08:44:57 +01:00
Allie Sadler
09dbd3fddf Apply suggestions from code review 2025-03-26 14:42:27 +00:00
aevesdocker
f15c10dd5b vscode tip 2025-03-24 11:54:24 +00:00
Allie Sadler
a9b3fe9a7b Merge pull request #22271 from aevesdocker/watch.include
watch include
2025-03-20 08:35:06 +00:00
Allie Sadler
4b21fc22d1 Merge pull request #22262 from aevesdocker/ENGDOCS-2489
ENGDOCS-2489
2025-03-17 15:10:36 +00:00
Allie Sadler
91676d373c CDI Compose support (#22131)
<!--Delete sections as needed -->

## Description

Adds https://github.com/compose-spec/compose-spec/pull/574

## 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-03-05 07:59:45 +00:00
Etienne Guerlain
1278c5b4c8 Update example in the Compose Build Specification (additional_contexts) to ease it's understanding (#22140)
There might by a slight error when illustrating the
`additional_contexts` attribute. The compose file declares two services
with the same name. It might induce misunderstanding, especially since
the second service's image uses the first one to build upon.

## Description

I replaced the key defining the second service of the compose file used
to illustrate the `additional_contexts` attribute, since the key `base`
is used twice. Of course, any better replacement could be used, instead
of `my-service`.

It is invalid to use the same key twice (the error: `mapping key "base"
already defined at line 2` is expected on `docker compose up`), and it
does harm the understanding of the illustrated point of building a
service's image using another one to share layers.

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-03-03 09:46:09 +00:00
Ville Skyttä
ae3eec2c70 docs: grammar and spelling fixes (#22136)
<!--Delete sections as needed -->

## Description

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

Fix a few grammar and spelling errors.


## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-02-28 14:13:37 -08:00
Allie Sadler
a0b3a20b96 Merge pull request #22089 from aevesdocker/ENGDOCS-2437
ENGDOCS-2437
2025-02-24 15:32:37 +00:00