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
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
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
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
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
035e26fb0b
docs: update link location for the overlay driver
...
File location changes in docker/docs#17176
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-05-12 17:33:53 +02:00
A. Lester Buck III
988e37956d
Correct "ps --no-trunc" example output
...
Signed-off-by: A. Lester Buck III <github-reg@nbolt.com>
2023-05-11 17:28:20 -05:00
Sebastiaan van Stijn
bc3f905a2a
Merge pull request #4223 from craig-osterhout/update-tag-documentation
...
docs: update tag docs to clarify name format
2023-05-09 17:26:42 +02:00
Craig Osterhout
4119d268e7
Update tag docs to clarify name
...
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2023-05-08 10:10:51 -07:00
Sebastiaan van Stijn
03752a6ba6
Merge pull request #4260 from dvdksn/docs/host-flag
...
docs: add description and examples for docker -H
2023-05-08 14:06:35 +02:00
David Karlsson
759fa585cf
docs: update description for docker -H flag
...
Signed-off-by: David Karlsson <david.karlsson@docker.com>
2023-05-07 21:45:55 +02:00
Brian Goff
f4201b9302
Merge pull request #4073 from panekj/feat/ssh-socket-path
...
connhelper: Allow socket path when using SSH
2023-05-05 15:50:18 -07:00
Sebastiaan van Stijn
9f15ba0d13
Merge pull request #4156 from AkihiroSuda/docker-run-annotation
...
cli/command/container: implement `docker run --annotation`
2023-05-06 00:49:15 +02:00
Chris Chinchilla
e693e7f3b4
Docs freshness updates
...
Signed-off-by: Chris Chinchilla <chris.ward@docker.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-26 15:37:12 +02:00
Sebastiaan van Stijn
0dec5d20a2
volumes: prune: add --all / -a option
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-20 23:31:47 +02:00
Akihiro Suda
88be16cb5b
cli/command/container: implement `docker run --annotation`
...
For moby/moby PR 45025 (Docker v24, API v1.43).
`docker run --annotation foo=bar` is similar to `podman run --annotation foo=bar`,
however, unlike Podman, Docker implementation also accepts an annotation with an empty value.
(`docker run --annotation foo`)
Signed-off-by: Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
2023-04-14 12:59:12 +09:00
Sebastiaan van Stijn
60d0659e40
Merge pull request #4199 from thaJeztah/docs_daemon_proxy_config
...
docs/reference: update dockerd docs for changes in 23.0
2023-04-13 21:55:50 +02:00
Sebastiaan van Stijn
375b17a312
docker info: don't print "registry" (IndexServerAddress)
...
The IndexServerAddress field was as part of the initial Windows implementation
of the engine. For legal reasons, Microsoft Windows (and thus Docker images
based on Windows) were not allowed to be distributed through non-Microsoft
infrastructure. As a temporary solution, a dedicated "registry-win-tp3.docker.io"
registry was created to serve Windows images.
Currently, this field always shows "https://index.docker.io/v1/ ", which is
confusing, because that address is not used for the registry (only for
authentication and "v1" search).
docker info
...
Registry: https://index.docker.io/v1/
Starting with b4ca1c7368
, this field is also
no longer used during authentication, and a3d56e7d06
removed the (deprecated) ElectAuthServer() which was previously used to
query it.
Given that there's currently no practical use for this information, and
it only adds "noise" (and confusion), this patch removes it from the default
output.
For now, the field is (still) available for those that want to use it;
docker info --format '{{.IndexServerAddress}}'
https://index.docker.io/v1/
But it won't be printed by default.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-13 14:49:14 +02:00
Sebastiaan van Stijn
c846428cb6
docs: update dockerd usage output for new proxy-options
...
Adds documentation for the options that were added in
427c7cc5f8
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-12 18:47:00 +02:00
Sebastiaan van Stijn
c730a8eb95
docs/reference: dockerd: remove default oom-score-adjust
...
The daemon no longer adjusts its oom-score by default; see
- 2b8e68ef06
- cf7a5be0f2
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-12 18:45:20 +02:00
Sebastiaan van Stijn
c209743612
docs/reference: dockerd: update seccomp flag description
...
Update the description for the changes made in;
68e96f88ee
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-12 18:41:27 +02:00
Sebastiaan van Stijn
32bc912008
docs/reference: dockerd: use table for env-vars
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-04-12 18:27:40 +02:00