852d198bb5
docs: add documentation for CDI
...
- Add section about cdi-spec-dirs daemon configuration
- Add subsection about cdi in --device section for docker run
- Update `docker info` output example
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-18 14:58:43 +01:00
22bbdc7984
docs: add "builder" key to full daemon.json example
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-16 20:19:06 +01:00
37f5515666
docs: fix broken link to tmpfs (missing anchor)
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-15 14:16:24 +01:00
b35361e8d2
docs: regenerate stubs for non-canonical commands
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-15 13:49:53 +01:00
a6774de682
docs: rename cli reference aliases to canonical
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-15 11:29:30 +01:00
cf9d3692a3
docs: remove empty cli reference stubs
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-15 11:19:39 +01:00
79992184e0
docs: dockerd: rephrase environment-variables intro
...
Slightly rephrase the intro (remove "easy reference"), and cross-reference
the corresponding section on the docker CLI page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-01-11 14:55:16 +01:00
4d2b4e7fba
docs: dockerd: fix stray column-separateor in env-var table
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-01-11 13:54:39 +01:00
909111b3ad
docs: fix incorrect heading levels in docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-05 16:41:26 +01:00
b36c16d38d
Merge pull request #4754 from thaJeztah/fix_seccomp_defaults
...
cli/command/container: parseSecurityOpts: fix --security-opt seccomp=builtin
2024-01-05 14:30:33 +01:00
6d0aa0a52d
cli/command/container: parseSecurityOpts: fix --security-opt seccomp=builtin
...
Docker v23.0 and up allow the daemon to be configured to have seccomp disabled
by default (using the "unconfined" profile as default), and introduced a new
"builtin" profile-name for the default (see [moby@f8795ed364586acd][1] and
[mnoby@ac449d6b5ad29a50][2]).
However, the CLI had no special handling for the "builtin" profile, which
resulted in it trying to load it as a file, which would fail;
docker run -it --rm --security-opt seccomp=builtin busybox
docker: opening seccomp profile (builtin) failed: open builtin: no such file or directory.
See 'docker run --help'.
This patch adds a special case for the "builtin" profile, to allow using the
default profile on daemons with seccomp disabled (unconfined) by default.
[1]: f8795ed364ac449d6b5a
2024-01-05 12:19:00 +01:00
9be600a97b
Docker build command docs refresh
...
Co-authored-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Chris Chinchilla <chris.ward@docker.com>
2024-01-05 00:07:34 +01:00
878b1c55b7
docs: add links to volume ls, network ls, stack ps formatting examples
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-03 16:53:47 +01:00
8dd2cda041
Merge pull request #1450 from lifubang/servicelsdoc
...
fixes id and name filter in service ls is the prefix not a part
2023-12-21 01:10:11 +01:00
60af715d65
id and name filter in service ls is the prefix not a part
...
Signed-off-by: Lifubang <lifubang@acmcoder.com>
2023-12-21 01:04:56 +01:00
90a1887d3c
Fix wrong docker run command
...
It forgot the image name ubuntu
Signed-off-by: QQ喵 <gqqnb2005@gmail.com>
2023-12-21 00:58:20 +01:00
64e9cadd1c
Add networking reference link
...
Co-authored-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Chris Chinchilla <chris.ward@docker.com>
2023-12-21 00:31:02 +01:00
5eac07b103
update typos and style in docs
...
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2023-12-19 19:30:55 +01:00
5ba998d6b4
Merge pull request #4712 from dvdksn/docs-tier1-fresshness-q4
...
docs: editorial improvements, typo fixes
2023-12-19 19:23:32 +01:00
6fd4cff1f7
docs: minor editorial improvements, typo fixes
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-19 17:15:38 +01:00
ca9ff8dafc
docs: run-reference: use table for health options
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-12-13 16:00:10 +01:00
d79dd7c531
docs, man: remove logentries logging-driver
...
This driver has been deprecated and removed because the service
is no longer operational. Remove it from the sample output.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-12-13 13:16:31 +01:00
103840e85e
Merge pull request #4615 from dvdksn/docs-cli-reference-refresh
...
docs: refactor cli run reference
2023-12-13 12:46:26 +01:00
f8dd8f074d
docs: refresh --publish, add --publish-all
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 22:36:26 +01:00
2e394eb5f4
docs: rewrite section on working directory
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:45:40 +01:00
4a84514552
docs: rewrite section on setting user id
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:07 +01:00
259aa90059
docs: rewrite section on filesystem mounts
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:07 +01:00
52716c813b
docs: move --tmpfs to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:07 +01:00
5ede4c82ac
docs: minor improvements to the healthcheck section
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:07 +01:00
7585d66a07
docs: rewrite section on overriding environment variables
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:07 +01:00
3eeac20593
docs: rewrite section on exposing ports
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-12 10:44:01 +01:00
0a94d85cd6
docs: fix typo in "network create" docs
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-12-11 22:33:52 +01:00
b01e287527
docs: rewrite section on default entrypoint
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:18:53 +01:00
c695ad9d74
docs: rewrite section on overriding image defaults
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:18:53 +01:00
4a6cde8859
docs: move --log-driver to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:18:51 +01:00
72df1960e1
docs: move --cgroup-parent to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
9e75a4cf61
docs: move --init to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
92c664b0dc
docs: move info about --security-opt to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
f98444490f
docs: move --rm to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
32189ca273
docs: improve description about container exit codes
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
dbffa0d121
docs: move --restart to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
73620975d0
docs: simplify container networking intro
...
Create an easier to digest introduction to container networking,
move the bulk of information to the networking overview page.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
5dd6e9a4d4
docs: move --ipc to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
ff62bf47b0
docs: move --uts to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
d66fe78810
docs: move --pid to docker run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
03dc8832ed
docs: improve docs on container identification
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
fad227d3fd
docs: move info about fg/bg flags to run reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
2f48f41fcb
docs: improve introduction to docker run
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-11 22:17:21 +01:00
a682b8e655
Permit '=' separator and '[ipv6]' in --add-host
...
Fixes #4648
Make it easier to specify IPv6 addresses in the '--add-host' option by
permitting 'host=ip' in addition to 'host:ip', and allowing square
brackets around the address.
For example:
--add-host=my-hostname:127.0.0.1
--add-host=my-hostname:::1
--add-host=my-hostname=::1
--add-host=my-hostname:[::1]
To avoid compatibility problems, the CLI will replace an '=' separator
with ':', and strip brackets, before sending the request to the API.
Signed-off-by: Rob Murray <rob.murray@docker.com>
2023-12-07 18:29:19 +00:00
c47141bde0
Merge pull request #4684 from dvdksn/fix-build-prune-cache-warn
...
prune: fix build cache prune warning
2023-12-06 00:18:19 +01:00
8bbc97c867
prune: fix build cache prune warning
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-05 20:11:15 +01:00
0acee94354
Merge pull request #4687 from TheRealGramdalf/dockerd-ref-patch
...
Fix typo in dockerd reference documentation
2023-12-03 14:50:41 +01:00
e93ec2f6a6
Fix typo in dockerd reference documentation
...
Signed-off-by: Graeme Wiebe <graeme.wiebe@gmail.com>
2023-12-02 15:18:27 -08:00
a431b1dda6
exec.md: remove misleading part
...
"By default" implies that this is something which could be
disabled for an individual `docker exec` call. This doesn't seem
to be the case, so removing the "by default" part would make
these docs clearer to me.
Signed-off-by: Per Lundberg <per.lundberg@hibox.tv>
2023-12-01 15:32:41 +02:00
654ff3ae00
Merge pull request #4681 from thaJeztah/noraw
...
docs: remove "{% raw %}" / "{% endraw %}" Jekyl (liquid) leftovers
2023-11-28 10:25:31 +01:00
354f62f0c5
docs: reference/commandlin/cli: remove redundant italic
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-27 22:05:49 +01:00
e2626200aa
docs: remove "{% raw %}" / "{% endraw %}" Jekyl (liquid) leftovers
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-27 22:05:39 +01:00
174cbb588f
docs/man: fix -name flag with single hyphen
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-27 20:58:55 +01:00
6468c63c81
docs: update debian examples to use bookworm
...
"bullseye" is no longer the "latest" debian, so these
examples were now incorrect.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-23 23:21:07 +01:00
7be05a6f44
mount: bind-recursive: remove boolean convenience values
...
- updates fc6976db4574bace156cfc6976db45
2023-11-22 11:22:38 +01:00
f387558b55
Add zstd as supported in load command doc
...
Signed-off-by: Hugo Chastel <Hugo-C@users.noreply.github.com>
2023-11-20 19:38:17 +01:00
a6114fc424
Merge pull request #4606 from AkihiroSuda/rro
...
docs: add `bind-recursive` mount option
2023-11-14 14:10:57 +01:00
fefadb9be6
Merge pull request #4642 from desmond3th/docFix
...
Updated docs for --env-file comments handling
2023-11-07 10:39:09 +01:00
efc9236794
--env-file about comments doc updated
...
Signed-off-by: Saurabh Kumar <saurabhkumar0184@gmail.com>
2023-11-07 01:44:47 +05:30
07338fe965
docs: update redirect metadata for hugo
...
docs.docker.com switched from Jekyll to Hugo, which uses "aliases"
instead of "redirect_from".
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-06 18:25:49 +01:00
848fe622ce
docs: add default-network-opt daemon option
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-06 10:48:36 +01:00
8bf121c3bc
Add docker ps status descriptions
...
Signed-off-by: Sam Thibault <sam.thibault@docker.com>
2023-10-20 12:43:16 +02:00
74bace156c
docs: add `bind-recursive` mount option
...
Follow-up to PR 4316
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2023-10-16 10:15:40 +09:00
3a16c3bb09
docs: fix duplicate words in "docker tag" reference
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-09-14 13:44:39 +02:00
6dfdd1eae9
cli/command/system: fix "docker events" not supporting --format=json
...
Before this patch:
docker events --format=json
json
json
json
^C
With this patch:
docker events --format=json
{"status":"create","id":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","from":"hello-world","Type":"container","Action":"create","Actor":{"ID":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","Attributes":{"image":"hello-world","name":"dreamy_goldstine"}},"scope":"local","time":1693168508,"timeNano":1693168508190136885}
{"status":"attach","id":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","from":"hello-world","Type":"container","Action":"attach","Actor":{"ID":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","Attributes":{"image":"hello-world","name":"dreamy_goldstine"}},"scope":"local","time":1693168508,"timeNano":1693168508192851593}
{"Type":"network","Action":"connect","Actor":{"ID":"c54920dd5074a73e28bea62007e0334d81cc040a90372be311cf16806403d350","Attributes":{"container":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","name":"bridge","type":"bridge"}},"scope":"local","time":1693168508,"timeNano":1693168508212398802}
{"status":"start","id":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","from":"hello-world","Type":"container","Action":"start","Actor":{"ID":"4ac3bba8abd68961e627540fed81ad16d55b88e45629d7cdb792126d09b6488d","Attributes":{"image":"hello-world","name":"dreamy_goldstine"}},"scope":"local","time":1693168508,"timeNano":1693168508312969843}
^C
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-29 14:48:49 +02:00
f1066d80e1
Merge pull request #4531 from thaJeztah/update_docs_tool
...
update cli-docs-tool to v0.6.0
2023-08-28 22:57:13 +02:00
3d2aac6a0d
docs/reference: run.md: remove stray whitespace
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-28 12:22:22 +02:00
dfca19a796
Merge pull request #4510 from thaJeztah/info_cdi_dirs
...
info: add CDI spec directories to output
2023-08-28 12:19:16 +02:00
17f4c8259b
update cli-docs-tool to v0.6.0
...
release notes: https://github.com/docker/cli-docs-tool/releases/tag/v0.6.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-28 01:58:58 +02:00
dc4feccb89
docs/reference: update links to Go documentation
...
Go documentation moved to the `go.dev` domain;
curl -sI https://golang.org/doc/install/source#environment | grep 'location'
location: https://go.dev/doc/install/source
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-25 14:10:40 +02:00
e050312e6d
update flag-description for --cgroup-parent
...
This attempts to make it clearer that the --cgroup-parent option is only used
for the containers used during build. Instead of mentioning "build container",
I opted for using "RUN instructions" (to match the --network description),
although this may not be ideal (as it assumes the "Dockerfile" front-end, which
of course may not be the case).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-23 11:39:32 +02:00
1c2cc4bbe3
info: add CDI spec directories to output
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-22 14:05:07 +02:00
6e2e92d774
Update docs/command output for volume pruning
...
In previous versions of the Docker API, `system prune --volumes` and `volume prune`
would remove all dangling volumes. With API v1.42, this was changed so that only
anonymous volumes would be removed unless the all filter was specified.
Some of the docs were updated in #4218 , however, there were a couple of places
left that didn't make the anonymous vs named volumes distinction clear.
This replaces #4079 , which was bitrotted by #4218 . See also #4028 .
Closes #4079 .
Signed-off-by: Ed Morley <501702+edmorley@users.noreply.github.com>
2023-08-12 14:22:23 +01:00
4fc3f0e6f6
search: deprecate "is-automated" filter and "IsAutomated" field
...
The IsAutomated field is being deprecated by Docker Hub's search API and
will always be "false" in future.
This patch:
- Deprecates the field and the related "is-automated" filter
- Removes the "AUTOMATED" column from the default output of "docker search"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-08-09 12:11:05 +02:00
69dcccf5b6
Merge pull request #4399 from dvdksn/docs/host-gateway
...
docs: document special host-gateway value for add-host
2023-08-08 21:04:47 +02:00
299925f4c3
docs: document special host-gateway value for add-host
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-08 17:37:44 +02:00
b52fd79f1d
docs: add missing docs for "DOCKER_TLS" env-var
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-07-19 15:03:40 +02:00
125eeb7ab6
Add docs for health-start-interval
...
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2023-07-06 19:41:34 +00:00
a26e6011f0
Merge pull request #4289 from dvdksn/docs/update-link-overlay-driver
...
docs: update link location for the overlay driver
2023-06-27 09:27:13 +02:00
5936fd2a86
docs: fix static ip example, network needs a subnet
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-06-26 15:42:50 +02:00
b85d6a8f9e
docs: fix broken link
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-06-26 15:01:19 +02:00
6c7d17fa01
docs: update the runtime configuration section
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-06-22 21:14:44 +02:00
47951ff446
docs: add "--detach-keys" example to docker run reference
...
This is a copy of the section we have on the "docker attach" reference page.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-08 14:37:21 +02:00
c17b0df2a5
docs: move "--detach-keys" example to examples section
...
Also adds a named anchor, so that the section gets linked from the
options table.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-08 14:35:03 +02:00
0b97e8aa1c
Merge pull request #4330 from dvdksn/docs/ssh-sock-path
...
docs: added example for specifying socket path with -H
2023-06-02 14:53:48 +02:00
b3a1180d26
Merge pull request #4307 from thaJeztah/remove_devicemapper
...
docs: remove devicemapper
2023-06-02 14:53:24 +02:00
e4ceed468e
docs: added example for specifying socket path with -H
...
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-06-02 14:39:57 +02:00
9828575314
docs: rephrase section on credential stores for docker login
...
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-06-01 17:27:50 +02:00
5d6612798a
docs: remove devicemapper
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-30 14:13:36 +02:00
2713d0bcde
docs: fix example for proxies in daemon.json
...
commit c846428cb6427c7cc5f8101dafd049
2023-05-19 17:21:34 +02:00
b131482f5c
Merge pull request #4288 from buck/no-trunc-example
...
Correct "ps --no-trunc" example output
2023-05-19 14:34:13 +02:00
b222900520
docs: remove AuFS from glossary
...
The AuFS storage driver was deprecated and now removed.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 10:17:37 +02:00
e4211c91ed
docs: remove Docker Toolbox from glossary
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 10:16:03 +02:00
c246ea8517
docs: remove boot2docker and docker-machine from glossary
...
boot2docker is deprecated, and so is docker-machine
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 10:16:03 +02:00
9f537a756e
docs: remove aufs and legacy overlay
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 01:21:24 +02:00
David Karlsson
Sebastiaan van Stijn
Sebastiaan van Stijn
Chris Chinchilla
Lifubang
QQ喵
Chris Chinchilla
Craig Osterhout
robmry
TheRealGramdalf
Per Lundberg
Hugo Chastel
saurabh
Sam Thibault
Akihiro Suda
Ed Morley
Brian Goff
David Karlsson