Noah Silas
9d5a2a6b66
docs: Correct `run` exit code 126 description
...
The command to run inside the container is `/etc`. The semicolon is a
statement terminator, which ends the command `docker run busybox /etc`,
while `echo $?` prints the exit code of that full docker command.
Having this mistake could confuse someone who thinks that `/etc; echo
$?` is all run inside the container, which wouldn't help the reader
understand the exit code of the `docker run` command itself.
Signed-off-by: Noah Silas <noah@hustle.com>
(cherry picked from commit 0c999fe95b
)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-11-13 23:37:10 +01:00
David Karlsson
d2aec10148
docs: fix a typo in run.md
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
(cherry picked from commit 54a20ce54c
)
Signed-off-by: Austin Vazquez <macedonv@amazon.com>
2024-10-04 06:07:07 +00:00
David Karlsson
2d7b8998c4
docs: use gh alert syntax for callouts
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
(cherry picked from commit f1befabe9f
)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-21 11:41:15 +02:00
Sebastiaan van Stijn
40707e17b8
docs: refresh image versions in examples
...
use current LTS versions of ubuntu where suitable, remove uses of
ubuntu:23.10 (which reache EOL), and and update some other examples
to use more current versions.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
(cherry picked from commit b36522b473
)
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2024-08-09 10:42:40 +02:00
Bjorn Neergaard
2ae903e86c
Merge pull request #4929 from dvdksn/privileged-flag
...
docs: clarify what the --privileged flag does
2024-03-20 09:10:03 -06:00
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
Sebastiaan van Stijn
5ba998d6b4
Merge pull request #4712 from dvdksn/docs-tier1-fresshness-q4
...
docs: editorial improvements, typo fixes
2023-12-19 19:23:32 +01:00
David Karlsson
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
Sebastiaan van Stijn
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
David Karlsson
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
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
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
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
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
Yucheng Wu
5d04b1c49e
note `--user` args usage restriction
...
Signed-off-by: Yucheng Wu <wyc123wyc@gmail.com>
2023-01-17 22:45:23 +01:00
Paweł Gronowski
720a6a8239
docs/run: Fix url to blog "Docker can now run within Docker"
...
Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
2022-12-29 14:33:34 +01:00
Sebastiaan van Stijn
9ba371f665
docs: update examples to not use deprecated images
...
using latest ubuntu LTS, and alpine for some examples. Also syncing some
wording between the man-pages and online docs.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-12-05 17:10:05 +01:00
Felix Geyer
4648c00848
docs: use correct separator in --security-opt
...
> Security options with `:` as a separator are deprecated and will be completely unsupported in 17.04, use `=` instead.
Signed-off-by: Felix Geyer <debfx@fobos.de>
2022-10-09 12:54:20 +02:00
Sebastiaan van Stijn
38992c2f76
Merge pull request #3704 from rouralberto/master
...
Removed feminine reference
2022-07-21 18:04:05 +02:00
Sebastiaan van Stijn
d84255c109
Merge pull request #3488 from SpringLeee/patch-1
...
docs: minimum memory limit 4M -> 6M
2022-07-21 12:30:49 +02:00
Alberto Roura
0b1b5957c7
Removed feminine reference
...
Signed-off-by: Alberto Roura <mail@albertoroura.com>
2022-07-13 11:17:32 +10:00
CrazyMax
f3ed630f8f
docs: dockerfile reference moved to buildkit repo
...
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
2022-06-27 11:51:46 +02:00
Ben Bodenmiller
e458cf1afc
Improve doc code formatting
...
Signed-off-by: Ben Bodenmiller <bbodenmiller@gmail.com>
2022-06-21 23:13:23 -07:00
Sebastiaan van Stijn
a4b6fe16ae
Merge pull request #3419 from iainelder/patch-1
...
Describe privileged mode in terms of capabilities
2022-04-02 00:13:50 +02:00