64c20f3013
Additional typo corrections
...
Signed-off-by: Iain MacDonald <ijmacd@gmail.com>
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2024-06-20 12:18:43 +02:00
a84536eb4a
Fix RFC3339 typo in docs
...
Signed-off-by: Iain MacDonald <ijmacd@gmail.com>
2024-06-20 12:18:28 +02:00
ed2d365653
Merge pull request #5141 from thaJeztah/carry_5040
...
Removed all mentions of "please" from docs and messages
2024-06-11 22:01:50 +02:00
e06ef800fc
Removed all mentions of "please" from docs and messages
...
Signed-off-by: Grace Choi <gracechoi@utexas.edu>
Signed-off-by: Pranjal Rai <pranjalrai@utexas.edu>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-06-11 16:53:40 +02:00
966fa7c475
cli/push: Add `platform` switch
...
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2024-06-11 16:39:48 +02:00
db2672e685
network create: make --ipv6 optional
...
The API field `EnableIPv6` was marked as optional in our Swagger docs,
and its default value in the Go client came from that field being a
bool, thus defaulting to its zero value. That's not the case anymore.
This field is now a `*bool` as to let daemon's config define the default
value. IPv6 can still be enabled / disabled by explicitly specifying the
`--ipv6` flag when doing `docker network create`.
Signed-off-by: Albin Kerouanton <albinker@gmail.com>
2024-06-07 03:17:46 +02:00
9acfbbd74f
Correct typos in docs/ and man/
...
Signed-off-by: Casey Korver <casey@korver.dev>
2024-06-06 02:15:23 +00:00
8ed44f916f
Merge pull request #4994 from robmry/47639_per-interface-sysctls
...
Document CLI support for per interface sysctls
2024-05-29 11:03:28 +02:00
d5d94e46fc
Explain how to use "network connect --driver-opt" to set sysctls
...
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-05-26 13:19:51 +01:00
b7583a2c28
Explain how to use "--network driver-opt" to set sysctls
...
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-05-26 13:17:22 +01:00
82ed39e319
docs: use --quiet in example to simplify output
...
The output showed the Alpine version that was used for the example,
which can get outdated and distracts from the example steps.
Use --quiet to reduce the output, and to reduce maintenance (i.e.,
no need to keep the output updated with current versions).
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-05-26 11:43:08 +02:00
6d21372dbb
run, create: update "--rm" flag description to mention anonymous volumes
...
The "--rm" flag deletes both the container and any anonymous volumes
associated with the container when the container exits.
This patch updates the flag description to also mention volumes.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-05-21 13:52:56 +02:00
c5dd1d0951
Merge pull request #5079 from cncal/patch-1
...
docs: fix json syntax error
2024-05-17 15:22:49 +02:00
cbe9469364
Merge pull request #5021 from neersighted/cdi_typos
...
docs: tidy up CDI docs
2024-05-17 15:06:44 +02:00
6a4d38c7f2
docs: fix json syntax error
...
Signed-off-by: cncal <flycalvin@qq.com>
2024-05-17 17:47:44 +08:00
0ad1d55b02
Merge pull request #4997 from dvdksn/doc-vxlan-listen-addr
...
docs: clarify that --data-path-addr doesn't restrict access
2024-05-13 18:54:43 +02:00
4758ed0b0d
Document the extended '--network' syntax
...
Support for connecting more than one network using the container run
command was added in v25.0 for API > 1.44 - describe that in the docs.
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-05-08 14:13:59 +01:00
1cc2e445af
Merge pull request #4967 from robmry/windows-no-dns-proxy
...
Feature option 'windows-dns-proxy'
2024-04-19 13:42:15 +02:00
762a85a103
Warn about deprecation of windows-dns-proxy flag
...
Signed-off-by: Albin Kerouanton <albinker@gmail.com>
2024-04-19 13:32:32 +02:00
287f482e31
Feature option 'windows-dns-proxy'
...
Document feature option 'windows-dns-proxy', which can be used to
enable or disable forwarding of DNS requests from the daemon's
internal resolver to external servers.
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-04-16 11:27:23 +01:00
116db4fc82
docs: tidy up CDI docs
...
Signed-off-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
2024-04-15 15:05:53 -07:00
4585809848
docs: add systempaths=unconfined security-opt
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-10 15:16:30 +02:00
faf096b25c
docs: clarify that --data-path-addr doesn't restrict access
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-09 13:08:21 +02:00
2ae903e86c
Merge pull request #4929 from dvdksn/privileged-flag
...
docs: clarify what the --privileged flag does
2024-03-20 09:10:03 -06:00
3da26a5e79
docs: add description and link for --userns flag
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-03-14 10:10:49 +01:00
4bb2abaa54
docs: typo fixes and other corrections
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-03-14 10:10:49 +01:00
9349f58b8a
docs: clarify what the --privileged flag does
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-03-11 15:59:09 +01:00
b55cf2f71f
Merge pull request #4931 from robmry/internal_network
...
Add a description of '--internal' to the docs
2024-03-11 12:41:29 +01:00
617377c045
Describe an 'internal' network.
...
Added a description of a '--internal' network (from @neersighted).
Co-authored-by: Bjorn Neergaard <bjorn.neergaard@docker.com>
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-03-11 09:13:25 +00:00
860b4f3a7d
'docker daemon' flags refer to the default bridge
...
Replace 'docker daemon' with the wording used for the preceeding table,
to make it extra-clear that those flags apply to the default bridge.
Signed-off-by: Rob Murray <rob.murray@docker.com>
2024-03-08 17:11:28 +00:00
238d659ff9
Add support for --detach/-d flag in stack rm
...
Added --detach/-d to stack rm. Setting --detach=false waits until
all of the stack tasks have reached a terminal state.
Co-authored-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: George Margaritis <gmargaritis@protonmail.com>
2024-03-04 09:56:53 +01:00
b086d72769
Add support for --detach flag in stack deploy
...
Added --detach and --quiet/-q flags to stack deploy. Setting --detach=false
waits until all of the stack services have converged. Shows progress bars for
each individual task, unless --quiet/-q is specified.
Co-authored-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: George Margaritis <gmargaritis@protonmail.com>
2024-03-04 09:36:36 +01:00
d51ba41791
docs: prefer -it over -ti
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-29 13:38:53 +01:00
a5b82e9f87
docs: fix typo in tty example
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-29 13:38:48 +01:00
48a670f26b
docs: fix invalid daemon.json examples
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-21 12:29:31 +01:00
f2e98f9a93
docs: regenerate markdown
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-02-21 10:40:13 +01:00
caf72655fb
docs: update url scheme for reference docs
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-20 21:38:50 +01:00
ec0a62436e
docs: update host-gateway-ip to use daemon.json instead of cli flag
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-23 15:45:59 +01:00
1c73abb634
Merge pull request #4800 from dvdksn/docs-fix-broken-alias-links
...
docs: fix broken links to alias pages
2024-01-19 15:06:33 +01:00
d633890f91
docs: move base command to docker.md
...
CLI reference for the base command was generated to cli.md
Changed it to docker.md to handle broken links.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-19 14:44:35 +01:00
aff4649cb7
docs: fix broken links to alias pages
...
Alias pages redirect to the canonical names, but these pages still
linked to the aliases, causing broken links when building the docs site.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-19 14:06:29 +01:00
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
Iain MacDonald
Sebastiaan van Stijn
Grace Choi
Paweł Gronowski
Albin Kerouanton
Casey Korver
Albin Kerouanton
Rob Murray
Sebastiaan van Stijn
cncal
Bjorn Neergaard
David Karlsson
George Margaritis
Chris Chinchilla
Lifubang
QQ喵
Chris Chinchilla
Craig Osterhout
robmry
TheRealGramdalf
Per Lundberg