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

291 Commits

Author SHA1 Message Date
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
Sebastiaan van Stijn
e495211493 engine: add v29.6 and v29.7 to API version matrix
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-08-03 12:24:29 +02:00
Alexa Kristensen
3448dcdcda Revert "docs: add Enterprise Data API reference and usage reports guide" (#25632)
Reverts docker/docs#25383
2026-07-23 11:59:20 -05:00
cassio-paesleme
a2d3787389 docs: add Enterprise Data API reference and usage reports guide (#25383)
## Summary

- Adds OpenAPI 3.0 spec and API reference page for the Docker Enterprise
Data API at `/reference/api/enterprise-data/`
- Adds feature guide for enterprise usage reports at
`/manuals/enterprise/reports/`

## Context

Docker Enterprise subscribers will be able to programmatically export
organization usage reports (pull data) via
`api.docker.com/enterprise-data/v1/`. This is a new API surface,
separate from the Hub API, supporting both PAT and OAT authentication.

Related PRs:
- API implementation:
[docker/data-platform#817](https://github.com/docker/data-platform/pull/817)
- FGA scope for OAT auth:
[docker/iam-services#1029](https://github.com/docker/iam-services/pull/1029)

## New pages

| Path | Description |
|---|---|
| `/reference/api/enterprise-data/api.yaml` | OpenAPI 3.0 spec (4
endpoints: list types, list reports, download, schema) |
| `/reference/api/enterprise-data/index.md` | API reference landing page
|
| `/manuals/enterprise/reports/_index.md` | Feature guide with auth
setup, curl walkthrough, pagination, troubleshooting |

## Test plan

- [ ] API reference renders correctly at
`/reference/api/enterprise-data/`
- [ ] Feature guide renders in the Enterprise sidebar
- [ ] curl examples are copy-pasteable and accurate


🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Alexa <alexa.kristensen@docker.com>
2026-07-23 11:26:34 -05:00
Craig Osterhout
7ca960b7a2 hub: fix broken link (#25625)
<!--Delete sections as needed -->

## Description

Fixed broken link.

## Related issues or tickets

Closes #25379

## Reviews

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

- [ ] Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-07-22 13:30:19 -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
Paweł Gronowski
543a863dcd Merge pull request #25343 from vvoland/update-docker
engine: 29.6.0
2026-06-18 22:48:02 +02:00
Paweł Gronowski
50595451ab engine: 29.6.0
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2026-06-18 22:44:56 +02:00
David Karlsson
b586d74072 Merge pull request #25392 from dvdksn/includes-cleanup
Remove unused includes and fail the build on broken include references
2026-06-18 17:55:06 +02: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
David Karlsson
e50562a9c7 sbx: vendor latest ai governance openapi spec
Sync the AI Governance Policy API reference with the upstream spec from
docker/governor-services. Renames the shared 403 response component from
PermissionDenied to Forbidden across the policy/rule endpoints, and adds a
limit_exceeded error code covering org policy and per-policy rule maximums.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-09 16:45:20 +02:00
Craig Osterhout
37fab0f3f7 offload: update activity log (#25268)
<!--Delete sections as needed -->

## Description

- Added note to Offload Activity logs page about the username and
details being displayed. Note that `user_id` and `org_id` is not
currently displayed in the event description/details.
- Added example to API docs showing what data is returned for Offload.
We don't currently document the data for all the event types, so I
avoided doing it inconsistently for Offload and instead opted to add it
as an example.

Previews:
-
https://deploy-preview-25268--docsdocker.netlify.app/admin/activity-logs/#offload-events
-
https://deploy-preview-25268--docsdocker.netlify.app/reference/api/hub/latest/#tag/audit-logs/operation/AuditLogs_ListAuditLogs

UI reference:
<img width="1617" height="678" alt="image"
src="https://github.com/user-attachments/assets/30a7cb6c-c6ea-43fc-981c-2856080ab9d2"
/>


## Related issues or tickets

ENGDOCS-3312

## Reviews

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

- [ ] Editorial review
- [ ] Product review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-06-08 11:30:18 -07:00
David Karlsson
4fdf475942 sbx: vendor latest ai governance openapi spec
Sync the AI Governance Policy API reference with the upstream spec from
docker/governor-services#242. Wraps the ListPolicies response data under
a `data` object, adds the updatePolicy and deletePolicy endpoints,
migrates policy scope from profiles to teams, and switches rule/policy
updates to application/json.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-04 13:01:57 +02:00
David Karlsson
2fe4b84081 sbx: fix ai governance api auth endpoint
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-06-02 17:17:27 +02:00
David Karlsson
553c69e1b7 sbx: restructure governance docs and add API reference (#25162)
## Summary

Restructures the Docker AI Governance documentation under
\`/ai/sandboxes/governance/\` and adds the supporting API reference.

Preview links:

-
https://deploy-preview-25162--docsdocker.netlify.app/ai/sandboxes/governance/
-
https://deploy-preview-25162--docsdocker.netlify.app/reference/api/ai-governance/

### Information architecture

The existing \`security/governance\` and \`security/policy\` pages are
merged into a new top-level \`governance\` section so local-policy and
org-policy sit side by side instead of being split across unrelated
parents:

- \`/ai/sandboxes/governance/\` — section landing; explains local + org
as layered enforcement
- \`/ai/sandboxes/governance/concepts/\` — resource model, rule syntax,
evaluation, precedence
- \`/ai/sandboxes/governance/local/\` — \`sbx policy\` CLI for
individual machines
- \`/ai/sandboxes/governance/org/\` — Admin Console flow (was
\`security/governance.md\`)
- \`/ai/sandboxes/governance/monitoring/\` — \`sbx policy ls\` / \`sbx
policy log\`

### API reference

\`/reference/api/ai-governance/\` renders the Governance OpenAPI spec
vendored at \`content/reference/api/ai-governance/api.yaml\` from
\`docker/governor-services\`. Operations, schemas, examples, and status
codes are fully driven by the spec — future updates land via re-vendor,
not in-repo edits. Anything wrong in the rendered reference should be
fixed upstream and re-vendored here.

The spec has been re-vendored to the latest upstream version, which
updated the server URL to \`hub.docker.com/v2\` and added the
\`/governance/\` prefix to all API paths.

### Review focus

1. The \`/ai/sandboxes/governance/\` landing — does the local + org
framing match how the product is positioned?
2. \`/reference/api/ai-governance/\` — does the rendered spec match the
source of truth, and is anything important missing?

Generated by Claude Code

---------

Co-authored-by: Louis-Arnaud <la.catoire@gmail.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-02 10:05:05 +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
Sebastiaan van Stijn
10c483da08 engine: update versions for v29.5.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-05-15 11:49:58 +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
David Karlsson
3f6b396fbb Replace page actions dropdown with inline row
Render the page actions (Ask Gordon, Copy Markdown, View Markdown) as
a horizontal row of icon links below the page title, separated from the
body by a divider — emulating the Stripe docs pattern. Drops the bordered
button + dropdown UI from md-dropdown.html and the Open in Claude entry.

Also clean up dead kapa.ai references: the "Ask Gordon" action now talks
to the Alpine gordon store directly instead of clicking the header
button via an open-kapa-widget class hook. The class, the unused
glossary link hook, and the dead params.kapa config block all go away.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-13 11:32:28 +02:00
David Karlsson
122761ce2f chore: refactor deprecated site.Data -> hugo.Data
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-05-01 09:22:27 +02:00
Alexa Kristensen
26ea39ec33 Agent redirect skill and small admin > company reorg (#24856)
This PR captures a small chunk of work intended to test a new agent
skill for handling redirect aliases, link references, and link anchors.
2026-04-24 07:50:35 -05:00
Alexa Kristensen
3619fb1780 Admin IA refresh (#24852)
PR to capture work:

- Update / simplify titles to match docs
- Create subcategories within org/company
- Wrestle with redirect nightmare part 2

Filing a follow up PR to create parallel structure in the `Company`
subcategory. This PR's scope is for `Organization` only.
2026-04-23 07:30:04 -05: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
Sebastiaan van Stijn
d558d46d14 engine: update API-version matrix and add Minimum API version
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-04-14 10:37:54 +02:00
David Karlsson
cdde205ba8 sandboxes: add sbx documentation
Add full documentation for the sbx CLI sandbox experience including
get-started, usage guide, architecture, agents (claude-code, codex,
copilot, gemini, kiro, opencode, cagent, custom-environments),
security (isolation, credentials, policy, workspace trust),
troubleshooting, and FAQ. Update _index.md as the section landing
page.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-03-31 17:35:01 +02:00
Claude Docs Agent
bf8999ae1b docs: update Engine API version to v1.54, docker CE to v29.3.0 2026-03-24 12:20:12 +01:00
David Karlsson
0f5c795327 Fix issue #24406: correct Docker Hub API documentation (#24443)
Fixes discrepancies in the Docker Hub organization access token API
documentation to match actual API behavior.

Changes:
- Removed `created_by` field from create endpoint response (API only
returns `created_at`)
- Updated scope examples from `repo-pull` to `scope-image-pull` (correct
format with `scope-` prefix)
- Enhanced repository path documentation with validation requirements
for TYPE_REPO resources

These changes align the OpenAPI specification with the actual API
implementation as discovered during Terraform provider development.

Fixes #24406

---------

Co-authored-by: David Karlsson <dvdksn@users.noreply.github.com>
2026-03-20 08:32:39 -07:00
Tiara Johnson
e7e28c4386 Update pricing url with ref and refAction params [GRO-282] (#24339)
## Description
In order to better attribute upgrade sources, we are adding two params -
`ref` and `refAction` to the existing pricing url.
The `ref` will be "Docs" and the `refAction` will be the particular docs
page from where the pricing url click is originated.

## Related issues or tickets
https://docker.atlassian.net/browse/GRO-282

## Reviews
@akristen You should see the new url params when hovering over or
clicking any of the updated pricing urls

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

---------

Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com>
2026-03-12 09:12:44 -05:00
Sebastiaan van Stijn
a2eb5a8189 engine: slight tweaks to client sdk examples
I noticed that building the examples would produce a client with the
default ("Go-http-client/1.1") User-Agent; this is something to look
into (probably should have a saner default), but regardless, it's
good practice to set your own;

- Update examples to show setting the User-Agent
- Use "log.Fatal" instead of "panic"; both exit the binary, but
  probably are slightly more readable.
- Use the authconfig.Encode utility, which codifies the canonical
  format to encode the JSON, so that users don't have to replicate
  the same format.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-03-11 16:22:17 +01:00
David Karlsson
eb22a5b867 Merge pull request #24182 from derekmisler/rebrand-docker-ai-references-to-gordon-across
Rebrand "Docker AI" references to "Gordon" across docs.docker.com
2026-03-09 17:21:34 +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
Derek Misler
1bf9cb9c3b Rebrand "Docker AI" references to "Gordon" across docs.docker.com
Signed-off-by: Derek Misler <derek.misler@docker.com>
2026-03-06 11:48:48 -05: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
Thomas Brüggemann
ca0020e2af Update Docker.DotNet link in C# library section
Fork because of unmaintained orginal repo.
2026-02-25 10:10:15 +01:00
David Karlsson
4899ea2cf1 chore: move cli data files to data subdir
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
David Karlsson
d5fd0b2f11 site: simplify base templates
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-23 17:29:32 +01:00
David Karlsson
aac0c7fe14 Merge pull request #24161 from dvdksn/mcp-profiles
MCP profiles
2026-02-23 16:27:26 +01:00
Sebastiaan van Stijn
c00894853f engine: update API version table
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-02-20 19:11:37 +01:00
David Karlsson
2db1ffab56 wip: vendor: mcp-gateway@v0.39.2 cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-20 12:10:52 +01:00
David Karlsson
f33d670bfb Merge pull request #24168 from dvdksn/upgrade-hugo-v0.156.0
upgrade hugo v0.156.0
2026-02-20 10:44:16 +01:00
David Karlsson
49d1f65b35 deps: upgrade to hugo v0.156.0 and fix deprecations 2026-02-19 16:09:15 +01:00
David Karlsson
541607aa12 sandboxes: note v0.12 prereq for opencode, shell, multi-workspace
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-19 14:47:53 +01:00
Craig Osterhout
4cae670c4d hub: add deletion note (#24078)
<!--Delete sections as needed -->

## Description

Delete operation may time-out. Hub automatically retries without user
interaction in both the UI and API.

Added notes to make the user aware.

## Related issues or tickets

ENGDOCS-3173

## Reviews

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

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

---------

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2026-02-18 14:56:52 -08:00