Commit Graph

228 Commits

Author SHA1 Message Date
1b1746cd69 Adding User Guide
* Added User Guide section outlines.
* Added User Guide to menu.
* Moved HTTPS example to articles.
* Replaced Hello World example with User Guide.
* Moved use cases out of examples.
* Updated Introduction to add User Guide.
* Redirected migrated /use and /articles links.
* Added Docker.io section
* Added Dockerized section
* Added Using Docker section
* Added Docker Images section
* Added Docker Links section
* Added Docker Volumes section

Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: a7b2c4804b2d98c2b5622db40d3d70b88529d7fe
Component: engine
2014-06-01 17:34:07 -04:00
b92a4a943f Merge pull request #6089 from unclejack/docker_build_copy
add support for COPY to docker build
Upstream-commit: 2024a0e517d9b5e009bd8935de60c4782cc1d17a
Component: engine
2014-06-01 01:26:31 +03:00
62daf025f0 updated documentation for mentioning images vs containers
Docker-DCO-1.1-Signed-off-by: Robin Speekenbrink <robin@kingsquare.nl> (github: fruitl00p)

rebased by

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: a0505edc9a890b3d4cdf5cf1850273c250c3dc41
Component: engine
2014-05-29 11:20:41 +10:00
e498aa81c8 add support for COPY to docker build
This adds a COPY command to docker build which works like ADD, but is
only for local files and it doesn't extract files.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 180c2a678510a93a442f1bcdb6a47287ec88ccd6
Component: engine
2014-05-29 00:07:52 +03:00
8f1ec933f0 Replace 'private' with 'self-hosted' in a couple of places
Docker-DCO-1.1-Signed-off-by: Jérôme Petazzoni <jerome@docker.com> (github: jpetazzo)
Upstream-commit: b64535166f4e930121bf9cb624bf2d044c97e472
Component: engine
2014-05-27 18:57:25 -07:00
c6fc71df20 docs/reference/builder: fix USER doc
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: proppy)
Upstream-commit: e89cb9a5e0105afbb0c1ba1176bda07d110295bc
Component: engine
2014-05-23 17:20:15 -07:00
456a42e6c9 Merge pull request #5839 from unclejack/improve_build_rm
add --force-rm to clean up after a failed build
Upstream-commit: db1a3551a34e054ee687545ab4922114d13d29d0
Component: engine
2014-05-22 10:54:05 -07:00
1e7aa2e3c4 remove chmod 755: fixes #5941
Docker-DCO-1.1-Signed-off-by: Tibor Vass <teabee89@gmail.com> (github: tiborvass)
Upstream-commit: 56a53c72d285b3f9fa6b34dcb81c9720a1974bde
Component: engine
2014-05-21 11:35:08 -07:00
7428c89c95 docs: cli.md; document docker version output
Commit 3cec63d56f9de6332aa3f33502695283d4feb054 changed the output of
docker version. Updating docs accordingly.

Docker-DCO-1.1-Signed-off-by: Jonathan McCrohan <jmccrohan@gmail.com> (github: jmccrohan)
Upstream-commit: 4052a81830e57c9f1d7d567ba9e53813945c9810
Component: engine
2014-05-20 02:00:31 +01:00
4c017922d1 default to deleting images via the remote api
This makes the remote API version 1.12 and newer default to
automatically deleting intermediate containers when the build has
succeedeed.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: b60d6471721bc914dca179a4372303d41913cc4c
Component: engine
2014-05-19 23:10:54 +03:00
978fda27ac bump remote api to 1.12 & add --force-rm to build
This adds a `--force-rm` flag to docker build which makes the Docker
daemon clean up all containers, even when the build has failed.

This new flag requires that we bump the remote API, so we also bump the
remote API version.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 667e2bd4ea5fbc8698c34565f955cb92cff92890
Component: engine
2014-05-19 23:10:49 +03:00
22e627f918 docs: add back build to remote api v1.10 & v1.11
This adds back the rm query parameter to the remote api docs for api
v1.10 and v1.11.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: e39299ca1d50df90b085e6a2e3e3f4b6897e5a59
Component: engine
2014-05-19 22:46:19 +03:00
823bf4bfec Check uid ranges
Fixes #5647
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
Upstream-commit: 72d1e40c4a3b190319cfa5cb44b5e6f1694100fc
Component: engine
2014-05-18 20:49:08 +04:00
96be0f9c84 Merge pull request #5832 from stevenburgess/documentation_cli_fix
Refactor b.tar -> busybox.tar
Upstream-commit: 4dabca90464f572f5a9ebeae3bdba8e77f6a353b
Component: engine
2014-05-17 09:42:20 +01:00
811e26ec97 Refactor b.tar -> busybox.tar
The file was saved as busybox.tar, but the ls commands named it b.tar.

Docker-DCO-1.1-Signed-off-by: Steven Burgess <steven.a.burgess@hotmail.com> (github: stevenburgess)
Upstream-commit: ddb99054bc9c04cce4ca761f9f0d822d67d614c4
Component: engine
2014-05-15 22:33:28 -04:00
98235fb032 Update the cli.md docs with the output of the docker command
Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: d35330bb7aa8473b92f6f45718aa6c38863cccc7
Component: engine
2014-05-16 10:00:20 +10:00
4cab943cdb changed deprecated option styles to supported ones
-name and -rm to --name and --rm
Upstream-commit: 10a320818e875547c83fecea32cd73231248acf8
Component: engine
2014-05-15 10:50:59 -04:00
f038890332 docs: explain when RUN cache gets invalidated
This adds a few lines to the RUN Dockerfile docs to explain how to
bypass the RUN caching and how ADD can also invalidate the cache for
these instructions.

Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Upstream-commit: 239d1ef301eb8d9b2b1e8469489b25ff3708f47f
Component: engine
2014-05-15 12:32:01 +03:00
3f28a1f79c Merge pull request #5762 from SvenDowideit/pr_out_add_some_more_specific_help_for_dockerfile_build_contexts
Add some more specific help for Dockerfile build contexts.
Upstream-commit: 8887e0063014228dbf3ff85083019adca4537ec0
Component: engine
2014-05-15 11:03:22 +10:00
d3d3386204 Add some more specific help for Dockerfile build contexts.
I've copy and pasted the error message so its googlable.

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: ed703fc8be652eee65319a774ffbe95a07a03242
Component: engine
2014-05-15 09:41:05 +10:00
4926e35bb1 Add cpuset cpus support for docker
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: adbe3096e8c8572925dbae5f19ac2ce2dc84fb1c
Component: engine
2014-05-13 18:17:12 -07:00
8c86f99ef3 Cleaned up Network settings overview
Upstream-commit: feb42d3f97f3a4de9317f17297c6277fcb0cc2af
Component: engine
2014-05-12 20:35:18 +02:00
c589c9a2f3 Added value format description for VOLUME instruction
In the documentation was not mentioned explicitly that VOLUME value
shoud be a valid JSON array. Because of this I spent time to discovering
the problem with my image where I put `VOLUME ['/data']` (with single quotes).
The `['/data']` mount point was parsed and mounted whole as a string without
any errors and warnings.

Docker-DCO-1.1-Signed-off-by: Max Shytikov <mshytikov@gmail.com> (github: mshytikov)
Upstream-commit: b5a37127aadbefea937346846116cb93966798dd
Component: engine
2014-05-09 16:37:55 +02:00
960115467c Fix link to daemon/execdriver/lxc/lxc_template.go
Upstream-commit: 5d39175c22b01cb31ebabb0c52de913a5541cd8b
Component: engine
2014-05-08 12:49:50 -04:00
9f2043420a update the docs to reflect the nice \n handling
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: cfb232cff27da2dd46ec04a5bf6699ab1d1df91c
Component: engine
2014-05-07 09:40:49 +10:00
65cf6af87c Update the run --net cli help to include the 'host' option
and then add that to the run and cli docs

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 9eeff6d099a951c3a3e45d63ce2f8cb158aaeb6c
Component: engine
2014-05-06 20:26:44 +10:00
1d128ba235 add linked containers to hosts file
Docker-DCO-1.1-Signed-off-by: Bryan Murphy <bmurphy1976@gmail.com> (github: bmurphy1976)

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Tested-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 53f38a14cd6b61a6b5df68cc3694dcba2b0c1eb7
Component: engine
2014-05-05 19:40:27 -07:00
d5f89ec02b Merge pull request #4441 from crosbymichael/add-net-flag
Add --net flag to docker run and allow host network stack
Upstream-commit: 70fef1460a9d253bdf164d70d7057ec4ee497e08
Component: engine
2014-05-05 13:54:55 -07:00
eebd02a00b Merge pull request #5569 from vieux/add__ping_to_the_API
Add  ping to the api
Upstream-commit: f369278725a2c31f5fa2ba2da33ad513f54a5897
Component: engine
2014-05-05 10:09:31 -07:00
ab8f143867 Add docs for --net flag
Docker-DCO-1.1-Signed-off-by: Michael Crosby <michael@crosbymichael.com> (github: crosbymichael)
Upstream-commit: c1c6b3ccd915084bc9472992afa16f677a074785
Component: engine
2014-05-05 10:08:59 -07:00
429d160907 Merge pull request #5568 from felixrabe/patch-6
cli.md: More typos
Upstream-commit: f33298024ba1f3bbcc9f51faefa16ee4de84f429
Component: engine
2014-05-03 12:50:57 +01:00
f47e440d42 Merge pull request #5572 from felixrabe/patch-5
run.md: Close braces
Upstream-commit: 49af92a7a98eba22303bd5d796bc3a2c88193948
Component: engine
2014-05-03 12:42:04 +01:00
e52ce63fdc Merge pull request #5564 from felixrabe/patch-4
cli.md: sudo at the right place
Upstream-commit: d0c97d5bd2ae3565736dabe4c44958f68e2b2355
Component: engine
2014-05-03 12:36:31 +01:00
7886f3a367 Merge pull request #5551 from felixrabe/patch-1
cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: b2268d1ac0e98440b0145040b13b99c3a0ac9c58
Component: engine
2014-05-03 21:02:25 +10:00
bb98c4c7b3 run.md: Close braces
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: 4a3b0e8d5d2653cfecbfee370be2406265211253
Component: engine
2014-05-03 02:20:59 +02:00
937cae5963 run.md: Convert some backticks to apo's
Upstream-commit: 205bd91fcab30292ac5f246ce9bdbb045ad1023f
Component: engine
2014-05-03 02:11:00 +02:00
57e3f2c8d8 cli.md: More typos
I've seen one other missing space that I addressed in another PR already.
I don't know whether that is a common occurrence in the docs.

About the second diff chunk, it looks like some copy-paste mistake to me.

Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: 015a2abafa92ecc61fe5828a285a1e6dcfa07693
Component: engine
2014-05-03 00:52:48 +02:00
554600b198 Merge pull request #5563 from felixrabe/patch-3
cli.md: Add space
Upstream-commit: cefb0d12775c92ed0ae439b126008bcedd7b2ce0
Component: engine
2014-05-02 23:33:48 +01:00
18e1876580 return write error
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: c65de2c0207ac67e5023ada8709490ef4627bd01
Component: engine
2014-05-02 22:03:59 +00:00
5f23d92b72 cli.md: sudo at the right place
Docker-DCO-1.1-Signed-off-by: Felix Rabe <felix@rabe.io> (github: felixrabe)
Upstream-commit: e318af6fb097ce5157b6766d8dfe921403858756
Component: engine
2014-05-02 23:58:05 +02:00
16cdcfd13d add doc
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 3c422fe5bf45391a509fd3c7f33033baefb0a234
Component: engine
2014-05-02 21:51:20 +00:00
6ac22e7613 cli.md: Add another sudo
Upstream-commit: 4706a1ad76ed9bc6c0555499d0bd8b8eea3b3604
Component: engine
2014-05-02 23:13:28 +02:00
0275c825eb cli.md: Add space
Upstream-commit: 12a4b376fd42931d959cd925983243e94c981de4
Component: engine
2014-05-02 22:56:35 +02:00
d4a39f6488 cli.md: Fix up Markdown formatting by adding one `
Upstream-commit: 877ad96d89093af8b16112c3534f4ceceaf1b7b3
Component: engine
2014-05-02 16:53:59 +02:00
61922080fe make sure the intermediate index.html files are generated consistently
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 5a8ffe7ef1c33996b9032fec2cf7cb2bf64793f0
Component: engine
2014-05-02 10:08:25 +10:00
491fb4c32b Bring back archived remote API versions
- git mv archived/* .
- put the links back into the summary document
- reduce the header depth by 1 so the TOC lists each API version
- update the mkdocs.yaml to render the archived API docs, but not add
  them to the menu/nav

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: de49e7c0a640aada97ace458a4e5d63f5f52d4eb
Component: engine
2014-05-02 09:47:33 +10:00
0f91626b0e Merge pull request #5524 from ostezer/docs-fix-codeblocks
Improve code/comment/output markings & display consistency
Upstream-commit: edab1bd5e5b3b179ea91e675cff6199de109558b
Component: engine
2014-05-01 19:39:06 -04:00
6a260a1e42 Timestamps for docker logs.
Fixes #1165
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
Upstream-commit: d1297feef8b124e69efc99a58294f498ecb8c022
Component: engine
2014-05-01 20:40:36 +04:00
3db0ad0993 Improve code/comment/output markings & display consistency
This PR aims to increase the consistency across the docs for
code blocks and code/comment/output markings.

Rule followed here is "what's visible on the screen should be reflected"

Issue:

 - Docs had various code blocks showing: comments, commands & outputs.
 - All three of these items were inconsistently marked.

Some examples as to how this PR aims to introduce improvements:

1. Removed `> ` from in front of the "outputs". Eg,
`    > REPOSITORY                 TAG       ID              CREATED` replaced with:
`    REPOSITORY                 TAG       ID              CREATED`.

2. Introduced `$` for commands. Eg,
`    sudo chkconfig docker on` replaced with:
`    $ sudo chkconfig docker on`

3. Comments:
`    > # ` replaced with:
`    # `.

> Please note:
> Due to a vast amount of items reviewed and changed for this PR, there
> might be some individually incorrect replacements OR patterns of incorrect
> replacements. This PR needs to be reviewed and if there is anything missing,
> it should be improved or amended.

Closes:
https://github.com/dotcloud/docker/issues/5286

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: f87a97f7df838742a602f1984f4552b803e3f92d
Component: engine
2014-05-01 17:52:01 +03:00
549ce4c50e remove rst/sphinx documentation
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: adf04681b4bd7293675b77b2397d87a5361b383b
Component: engine
2014-05-01 15:31:58 +10:00