Commit Graph

49 Commits

Author SHA1 Message Date
e381bb96ca Fix apparent copy paste mistake
The note under the RUN header refers to the CMD instruction. It should refer to the RUN instruction instead.

Signed-off-by: Huu Nguyen <whoshuu@gmail.com>
Upstream-commit: 86e72c6e06
Component: cli
2017-06-02 00:06:39 +00:00
2c48eb8298 Clarify USER instruction documentation
Reuse WORKDIR wording to specify that the USER instructions affect the
following RUN, CMD, and ENTRYPOINT instructions.

Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 7caa149d5f
Component: cli
2017-06-02 00:06:39 +00:00
31abb69581 Tweaks to Dockerfile tutorial
Made a few tweaks to Dockerfile tutorial links and removed some cruft from the tutorial itself.

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: a6ba3f585b
Component: cli
2017-06-02 00:06:37 +00:00
ab2803a8e5 builder: Update documentation WRT environment replacement
Docker-DCO-1.1-Signed-off-by: Erik Hollensbe <github@hollensbe.org> (github: erikh)
Upstream-commit: 15192a0bc1
Component: cli
2017-06-02 00:06:37 +00:00
e55b45b1a6 Rewrite ENTRYPOINT documentation covering all the combinations with examples.
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 9efb51fbc1
Component: cli
2017-06-02 00:06:37 +00:00
6b65799e84 Fixed a minor docs issue in a Dockerfile Example
The Dockerfile Instruction to create the .vnc directory results in a failure :
-storepasswd failed for file: /root/.vnc/passwd

Signed-off-by: Madhu Venugopal <madhu@socketplane.io>
Upstream-commit: a6594e13ce
Component: cli
2017-06-02 00:06:37 +00:00
dc688c1670 Add ENV variables support to WORKDIR build command
Docker-DCO-1.1-Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com> (github: unclejack)
Docker-DCO-1.1-Signed-off-by: Adrien Folie <folie.adrien@gmail.com> (github: folieadrien)

Conflicts:
	builder/builder.go
		This file has been deleted.
Upstream-commit: 410719e6df
Component: cli
2017-06-02 00:06:36 +00:00
7f828fa717 Add note to docs about lack of shell processing in JSON form
Closes #5509

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 49323dfac9
Component: cli
2017-06-02 00:06:36 +00:00
08787f1ac5 Doc update to clarify EXPOSE vs -p functionality.
Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
Upstream-commit: 1d2bb271ac
Component: cli
2017-06-02 00:06:35 +00:00
28be9d5897 Add more info about when build cache is invalidated/used - Issue #3636
Plus some edits as suggested by @jamtur01

Closes #3636

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 0e82ab713b
Component: cli
2017-06-02 00:06:35 +00:00
da4bfdb14a add wildcard support to copy/add
Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 1a83c9f87e
Component: cli
2017-06-02 00:06:35 +00:00
ce71b7d929 builder: Fix handling of VOLUME command where multiple volumes are
specified in a space delimited list.

Docker-DCO-1.1-Signed-off-by: Erik Hollensbe <github@hollensbe.org> (github: erikh)
Upstream-commit: 82ff6f0c9f
Component: cli
2017-06-02 00:06:35 +00:00
dcdc597a18 Adding new Dockerfile Best Practices doc, and links thereto.
Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: 85808d776d
Component: cli
2017-06-02 00:06:35 +00:00
17eed5a7b8 Add support for copy/add with multiple src files
Part one of solution for issue #6820

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 6ea2cc5e0e
Component: cli
2017-06-02 00:06:34 +00:00
c6cd0c88d2 Consistently use 'sudo docker' in examples
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
Upstream-commit: 3ca630d381
Component: cli
2017-06-02 00:06:34 +00:00
632772241e Add notes about single-quotes
Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: f0b5f2601f
Component: cli
2017-06-02 00:06:34 +00:00
33b2b9f6b8 Fixed a typo and added a bit based on Sven's feedback
Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: e06e910b87
Component: cli
2017-06-02 00:06:33 +00:00
6fe3a11825 Added warning re: using root for dockerfile root. Fixes #7612
Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
Upstream-commit: f30add12fe
Component: cli
2017-06-02 00:06:33 +00:00
5e62cf124c fix for issue 7281
add missing comma per O.S. Tezer's commment

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: d31f289d22
Component: cli
2017-06-02 00:06:32 +00:00
14d1356fcf Make it clear that JSON array format should be used if CMD is used as default arguments
Signed-off-by: Xuecong Liao <satorulogic@gmail.com>
Upstream-commit: e778875858
Component: cli
2017-06-02 00:06:32 +00:00
0ddf7346b7 Fix example of relative WORKDIR
Docker-DCO-1.1-Signed-off-by: Alexandr Morozov <lk4d4math@gmail.com> (github: LK4D4)
Upstream-commit: 83b89cd5cd
Component: cli
2017-06-02 00:06:32 +00:00
cc9ecd5a3b Standardize "apt-get install" usage across the repo
I might have missed some, but I think this is most of the offenders.

Docker-DCO-1.1-Signed-off-by: Andrew Page <admwiggin@gmail.com> (github: tianon)
Upstream-commit: cc74364de9
Component: cli
2017-06-02 00:06:32 +00:00
7d18ebcbe5 Fix incorrect path in ENTRYPOINT example
The ENTRYPOINT example uses "/usr/bin/ls" as path, but `ls` is located at `/bin/ls`.

Docker-DCO-1.1-Signed-off-by: Sebastiaan van Stijn <github@gone.nl> (github: thaJeztah)
Upstream-commit: c290eb9a8c
Component: cli
2017-06-02 00:06:32 +00:00
5aee68c291 update go import path and libcontainer
Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
Upstream-commit: 4fc06d1790
Component: cli
2017-06-02 00:06:32 +00:00
b90677256a General cleanup of the builder.md file
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 6c10e6fe81
Component: cli
2017-06-02 00:06:31 +00:00
cca16c6e5d Rewrote the ENTRYPOINT section in builder
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 7cf495874c
Component: cli
2017-06-02 00:06:31 +00:00
b46f5536f0 Explain ADD invalidation more accurately
And also move it in to the `ADD` section, rather than being hidden in the `RUN` section.

Docker-DCO-1.1-Signed-off-by: Daniel Watkins <daniel@daniel-watkins.co.uk> (github: OddBloke)
Upstream-commit: 383db402ca
Component: cli
2017-06-02 00:06:31 +00:00
2b487e12ac more docs for dockerignore
Docker-DCO-1.1-Signed-off-by: Tibor Vass <teabee89@gmail.com> (github: tiborvass)
Upstream-commit: e7e6ff5e6f
Component: cli
2017-06-02 00:06:30 +00:00
6d5a7032bc api/client/build: allow tar as context for docker build -
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: proppy)
Upstream-commit: 56b7c20e46
Component: cli
2017-06-02 00:06:29 +00:00
95e82d22aa Clean up some uses on 'an' in builder docs
Upstream-commit: 983c74aced
Component: cli
2017-06-02 00:06:29 +00:00
b3b3cfe083 Fix minor typo and improve wording
Upstream-commit: 0e185f84fb
Component: cli
2017-06-02 00:06:29 +00:00
3e31de1e07 Guillaume is busy full-time on his new business, and no longer available
as a maintainer.

Best of luck on your e-commerce business Guillaume, and thanks for all
the great contributions!

Docker-DCO-1.1-Signed-off-by: Solomon Hykes <solomon@docker.com> (github: shykes)
Upstream-commit: 5182afe46e
Component: cli
2017-06-02 00:06:29 +00:00
e9a2e33699 Fix typo
Upstream-commit: 1fa4c8b6b0
Component: cli
2017-06-02 00:06:29 +00:00
3bdd41dcd9 Update builder.md
Upstream-commit: 1b06f322c5
Component: cli
2017-06-02 00:06:28 +00:00
c35401aba5 Change 'Uploading context' wording
Docker-DCO-1.1-Signed-off-by: Ryan Stelly <ryan.stelly@live.com> (github: FLGMwt)
Upstream-commit: 47f850e550
Component: cli
2017-06-02 00:06:28 +00:00
fbc53f4fc0 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: 74a03f6def
Component: cli
2017-06-02 00:06:28 +00:00
a1de49d92a 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: 5f1114d955
Component: cli
2017-06-02 00:06:28 +00:00
8dd475f4d6 docs/reference/builder: fix USER doc
Docker-DCO-1.1-Signed-off-by: Johan Euphrosine <proppy@google.com> (github: proppy)
Upstream-commit: 7f3fe5c01e
Component: cli
2017-06-02 00:06:28 +00:00
ac2df4daba remove chmod 755: fixes #5941
Docker-DCO-1.1-Signed-off-by: Tibor Vass <teabee89@gmail.com> (github: tiborvass)
Upstream-commit: 8ee2a06dcf
Component: cli
2017-06-02 00:06:28 +00:00
28e2d18a14 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: 4fe816bff2
Component: cli
2017-06-02 00:06:27 +00:00
b5ba629702 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: 44841e361a
Component: cli
2017-06-02 00:06:27 +00:00
6c147c29d3 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: b8073c74a7
Component: cli
2017-06-02 00:06:26 +00:00
5354d49235 Looking into some broken links, I noticed that we don't need to use
relative paths, and also fixed some broken images.

There are still more todo - next PR I think :)

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: ecc2740a94
Component: cli
2017-06-02 00:06:26 +00:00
a987506ace Docs auto-conversion fixes and MD marking and structure improvements.
- Remove redundant chars and all errors caused by RST->MD conversion.
   e.g. [/#, /\, \<, />, etc.]
 - Fix broken inter-document links
 - Fix outbound links no-longer active or changed
 - Fix lists
 - Fix code blocks
 - Correct apostrophes
 - Replace redundant inline note marks for code with code marks
 - Fix broken image links
 - Remove non-functional title links
 - Correct broken cross-docs links
 - Improve readability

Note: This PR does not try to fix/amend:

 - Grammatical errors
 - Lexical errors
 - Linguistic-logic errors etc.

It just aims to fix main structural or conversion errors to serve as
a base for further amendments that will cover others including but
not limited to those mentioned above.

Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)

Update:

 - Fix backtick issues

Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit)
Upstream-commit: 148a2be878
Component: cli
2017-06-02 00:06:26 +00:00
89cd80886d Introducing spīritus lēnis to fix code highlighting issues due to apostrophe.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 149437ff87
Component: cli
2017-06-02 00:06:26 +00:00
2fc7ce6db3 Mark notes and warnings, fix broken link renderings within.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 34628fa8a4
Component: cli
2017-06-02 00:06:26 +00:00
7329c385c5 Fixed #5283 - literal leftover from cutover
Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
Upstream-commit: 57acc3cd5d
Component: cli
2017-06-02 00:06:26 +00:00
d25c401844 Fix for broken in-document links which got scrambled during conversion.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
Upstream-commit: 35710efce1
Component: cli
2017-06-02 00:06:25 +00:00
521190558c now, with shiney markdown
Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
Upstream-commit: 88a30886e5
Component: cli
2017-06-02 00:06:25 +00:00