Sebastiaan van Stijn
0acee94354
Merge pull request #4687 from TheRealGramdalf/dockerd-ref-patch
...
Fix typo in dockerd reference documentation
2023-12-03 14:50:41 +01:00
TheRealGramdalf
e93ec2f6a6
Fix typo in dockerd reference documentation
...
Signed-off-by: Graeme Wiebe <graeme.wiebe@gmail.com>
2023-12-02 15:18:27 -08:00
Per Lundberg
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
Sebastiaan van Stijn
654ff3ae00
Merge pull request #4681 from thaJeztah/noraw
...
docs: remove "{% raw %}" / "{% endraw %}" Jekyl (liquid) leftovers
2023-11-28 10:25:31 +01:00
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
7be05a6f44
mount: bind-recursive: remove boolean convenience values
...
- updates fc6976db45
- updates 74bace156c
Commit fc6976db45
introduced support for the
`bind-recursive` option on `--mount`, and deprecated the `bind-nonrecursive`
option. Unlike `bind-nonrecursive` boolean, the `bind-recursive` option
accepts a string value with multiple options.
For convenience, the `bind-recursive` option also was made to accept boolean
values (true/false, 1/0). However, as the option works as the _reverse_ of
`bind-nonrecursive` (`bind-nonrecursive=true` === `bind-recursive=false`),
the new option won't be a "drop-in" replacement, and having more options
to choose from may only be adding more complexity / cognitive overload.
This patch removes support for boolean values; if we see a need to add
support for boolean values in future, it would be trivial to add back this
functionality.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-11-22 11:22:38 +01:00
Hugo Chastel
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
Sebastiaan van Stijn
a6114fc424
Merge pull request #4606 from AkihiroSuda/rro
...
docs: add `bind-recursive` mount option
2023-11-14 14:10:57 +01:00
Sebastiaan van Stijn
fefadb9be6
Merge pull request #4642 from desmond3th/docFix
...
Updated docs for --env-file comments handling
2023-11-07 10:39:09 +01:00
saurabh
efc9236794
--env-file about comments doc updated
...
Signed-off-by: Saurabh Kumar <saurabhkumar0184@gmail.com>
2023-11-07 01:44:47 +05:30
Sebastiaan van Stijn
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
David Karlsson
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
Sam Thibault
8bf121c3bc
Add docker ps status descriptions
...
Signed-off-by: Sam Thibault <sam.thibault@docker.com>
2023-10-20 12:43:16 +02:00
Akihiro Suda
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Ed Morley
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
David Karlsson
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
Sebastiaan van Stijn
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
Brian Goff
125eeb7ab6
Add docs for health-start-interval
...
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
2023-07-06 19:41:34 +00:00
Sebastiaan van Stijn
88f44ec159
cli: SetupRootCommand: remove redundant flags return
...
The flag-set that was returned is a pointer to the command's Flags(), which
is in itself passed by reference (as it is modified / set up).
This patch removes the flags return, to prevent assuming it's different than
the command's flags.
While SetupRootCommand is exported, a search showed that it's only used internally,
so changing the signature should not be a problem.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-06-28 16:26:50 +02:00
Sebastiaan van Stijn
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
David Karlsson
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
David Karlsson
b85d6a8f9e
docs: fix broken link
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-06-26 15:01:19 +02:00
David Karlsson
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
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
Sebastiaan van Stijn
b3a1180d26
Merge pull request #4307 from thaJeztah/remove_devicemapper
...
docs: remove devicemapper
2023-06-02 14:53:24 +02:00
David Karlsson
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
David Karlsson
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
Sebastiaan van Stijn
5d6612798a
docs: remove devicemapper
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-30 14:13:36 +02:00
Sebastiaan van Stijn
2713d0bcde
docs: fix example for proxies in daemon.json
...
commit c846428cb6
added proxies to the
example `daemon.json`, based on the implementation that was added in
427c7cc5f8
.
However, a follow-up pull request changed the proxy-configuration in`daemon.json`
to nest the configuration in a "proxies" struct, and the documentation was
not updated accordingly; see:
101dafd049
This patch fixes the example.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 17:21:34 +02:00
Sebastiaan van Stijn
b131482f5c
Merge pull request #4288 from buck/no-trunc-example
...
Correct "ps --no-trunc" example output
2023-05-19 14:34:13 +02:00
Sebastiaan van Stijn
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
Sebastiaan van Stijn
e4211c91ed
docs: remove Docker Toolbox from glossary
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 10:16:03 +02:00
Sebastiaan van Stijn
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
Sebastiaan van Stijn
c61b565183
docs/deprecated: remove "disabled by default" for AuFS, overlay
...
These drivers have been removed in docker 24.0, so it's no longer
possible to enable them.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-05-19 01:21:35 +02:00