eea26c50dd
docs: update links to docker cli reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit 3d4c12af73 )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:42 +02:00
1cf2c4efb3
docs: regenerate base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit bf33c8f10a )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:39 +02:00
c2b9c1474a
docs: align heading structure for base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit b0650f281e )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:35 +02:00
598442d37d
docs: remove frontmatter for base command
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit cfea2353b3 )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:32 +02:00
c964b80e53
docs: rename cli.md to docker.md (base command)
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit 03961449aa )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:27 +02:00
0ca7be015e
docs: remove empty docker base command reference
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit a683823383 )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-05 15:20:22 +02:00
27bf78d335
docs: make buildx build the canonical reference doc
...
Move common flag descriptions to the buildx build reference, and make
that page the canonical page in docs. Also rewrite some content in
image_build to make clear that this page is only for the legacy builder.
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
(cherry picked from commit e91f0ded9c )
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-04 09:19:10 +02:00
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
cbe9469364
Merge pull request #5021 from neersighted/cdi_typos
...
docs: tidy up CDI docs
2024-05-17 15:06:44 +02: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
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
...
build / prepare-plugins (push) Has been cancelled
build / plugins (push) Has been cancelled
codeql / codeql (push) Has been cancelled
e2e / e2e (alpine, 23, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 23, experimental) (push) Has been cancelled
e2e / e2e (alpine, 23, non-experimental) (push) Has been cancelled
e2e / e2e (alpine, 24, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 24, experimental) (push) Has been cancelled
e2e / e2e (alpine, 24, non-experimental) (push) Has been cancelled
e2e / e2e (alpine, 25, connhelper-ssh) (push) Has been cancelled
e2e / e2e (alpine, 25, experimental) (push) Has been cancelled
e2e / e2e (alpine, 25, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 23, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 23, experimental) (push) Has been cancelled
e2e / e2e (debian, 23, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 24, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 24, experimental) (push) Has been cancelled
e2e / e2e (debian, 24, non-experimental) (push) Has been cancelled
e2e / e2e (debian, 25, connhelper-ssh) (push) Has been cancelled
e2e / e2e (debian, 25, experimental) (push) Has been cancelled
e2e / e2e (debian, 25, non-experimental) (push) Has been cancelled
test / ctn (push) Has been cancelled
test / host (macos-12) (push) Has been cancelled
validate / validate (lint) (push) Has been cancelled
validate / validate (shellcheck) (push) Has been cancelled
validate / validate (update-authors) (push) Has been cancelled
validate / validate (validate-vendor) (push) Has been cancelled
validate / validate-md (push) Has been cancelled
validate / validate-make (manpages) (push) Has been cancelled
validate / validate-make (yamldocs) (push) Has been cancelled
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
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
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