diff --git a/components/cli/docs/sources/reference/builder.md b/components/cli/docs/sources/reference/builder.md index c976c118d7..3e278425c2 100644 --- a/components/cli/docs/sources/reference/builder.md +++ b/components/cli/docs/sources/reference/builder.md @@ -57,7 +57,7 @@ accelerating `docker build` significantly (indicated by `Using cache`): When you're done with your build, you're ready to look into [*Pushing a repository to its registry*]( -../../use/workingwithrepository/#image-push). +/use/workingwithrepository/#image-push). ## Format @@ -71,7 +71,7 @@ be UPPERCASE in order to distinguish them from arguments more easily. Docker evaluates the instructions in a Dockerfile in order. **The first instruction must be \`FROM\`** in order to specify the [*Base -Image*](../../terms/image/#base-image-def) from which you are building. +Image*](/terms/image/#base-image-def) from which you are building. Docker will treat lines that *begin* with `#` as a comment. A `#` marker anywhere else in the line will @@ -91,11 +91,11 @@ Or FROM : -The `FROM` instruction sets the [*Base Image*](../../terms/image/#base-image-def) +The `FROM` instruction sets the [*Base Image*](/terms/image/#base-image-def) for subsequent instructions. As such, a valid Dockerfile must have `FROM` as its first instruction. The image can be any valid image – it is especially easy to start by **pulling an image** from the [*Public Repositories*]( -../../use/workingwithrepository/#using-public-repositories). +/use/workingwithrepository/#using-public-repositories). `FROM` must be the first non-comment instruction in the Dockerfile. @@ -191,9 +191,9 @@ default specified in CMD. The `EXPOSE` instructions informs Docker that the container will listen on the specified network ports at runtime. Docker uses this information to interconnect containers using links (see -[*links*](../../use/working_with_links_names/#working-with-links-names)), +[*links*](/use/working_with_links_names/#working-with-links-names)), and to setup port redirection on the host system (see [*Redirect Ports*]( -../../use/port_redirection/#port-redirection)). +/use/port_redirection/#port-redirection)). ## ENV @@ -327,7 +327,7 @@ The `VOLUME` instruction will create a mount point with the specified name and mark it as holding externally mounted volumes from native host or other containers. For more information/examples and mounting instructions via docker client, refer to [*Share Directories via Volumes*]( -../../use/working_with_volumes/#volume-def) documentation. +/use/working_with_volumes/#volume-def) documentation. ## USER diff --git a/components/cli/docs/sources/reference/commandline/cli.md b/components/cli/docs/sources/reference/commandline/cli.md index d59bd37674..6388cb6192 100644 --- a/components/cli/docs/sources/reference/commandline/cli.md +++ b/components/cli/docs/sources/reference/commandline/cli.md @@ -197,7 +197,7 @@ and a "context". The files at `PATH` or `URL` are called the "context" of the build. The build process may refer to any of the files in the context, for example when using an -[*ADD*](../../builder/#dockerfile-add) instruction. When a single Dockerfile is +[*ADD*](/reference/builder/#dockerfile-add) instruction. When a single Dockerfile is given as `URL`, then no context is set. When a Git repository is set as `URL`, then the @@ -209,7 +209,7 @@ vpn's etc can be used to access private repositories See also: -[*Dockerfile Reference*](../../builder/#dockerbuilder). +[*Dockerfile Reference*](/reference/builder/#dockerbuilder). ### Examples: @@ -248,7 +248,7 @@ machine and that no parsing of the Dockerfile happens at the client side (where you're running `docker build`). That means that *all* the files at `PATH` get sent, not just the ones listed to -[*ADD*](../../builder/#dockerfile-add) in the Dockerfile. +[*ADD*](/reference/builder/#dockerfile-add) in the Dockerfile. The transfer of context from the local machine to the Docker daemon is what the `docker` client means when you see the @@ -843,10 +843,10 @@ of all containers. The `docker run` command can be used in combination with `docker commit` to [*change the command that a container runs*](#commit-an-existing-container). -See [*Redirect Ports*](../../../use/port_redirection/#port-redirection) +See [*Redirect Ports*](/use/port_redirection/#port-redirection) for more detailed information about the `--expose`, `-p`, `-P` and `--link` parameters, and [*Link Containers*]( -../../../use/working_with_links_names/#working-with-links-names) for specific +/use/working_with_links_names/#working-with-links-names) for specific examples using `--link`. ### Known Issues (run –volumes-from) @@ -914,14 +914,14 @@ manipulate the host's docker daemon. $ sudo docker run -p 127.0.0.1:80:8080 ubuntu bash This binds port `8080` of the container to port `80` on `127.0.0.1` of the host -machine. [*Redirect Ports*](../../../use/port_redirection/#port-redirection) +machine. [*Redirect Ports*](/use/port_redirection/#port-redirection) explains in detail how to manipulate ports in Docker. $ sudo docker run --expose 80 ubuntu bash This exposes port `80` of the container for use within a link without publishing the port to the host system's interfaces. [*Redirect Ports*]( -../../../use/port_redirection/#port-redirection) explains in detail how to +/use/port_redirection/#port-redirection) explains in detail how to manipulate ports in Docker. $ sudo docker run -e MYVAR1 --env MYVAR2=foo --env-file ./env.list ubuntu bash @@ -1074,7 +1074,7 @@ Search the docker index for images -t, --trusted=false: Only show trusted builds See [*Find Public Images on the Central Index*]( -../../../use/workingwithrepository/#searching-central-index) for +/use/workingwithrepository/#searching-central-index) for more details on finding shared images from the commandline. ## start @@ -1107,7 +1107,7 @@ Tag an image into a repository You can group your images together using names and tags, and then upload them to [*Share Images via Repositories*]( -../../../use/workingwithrepository/#working-with-the-repository). +/use/workingwithrepository/#working-with-the-repository). ## top @@ -1124,4 +1124,4 @@ version. Usage: docker wait [OPTIONS] NAME -Block until a container stops, then print its exit code. \ No newline at end of file +Block until a container stops, then print its exit code. diff --git a/components/cli/docs/sources/reference/run.md b/components/cli/docs/sources/reference/run.md index f6f132a09d..9de08ec1a6 100644 --- a/components/cli/docs/sources/reference/run.md +++ b/components/cli/docs/sources/reference/run.md @@ -7,25 +7,25 @@ page_keywords: docker, run, configure, runtime **Docker runs processes in isolated containers**. When an operator executes `docker run`, she starts a process with its own file system, its own networking, and its own isolated process tree. -The [*Image*](../../terms/image/#image-def) which starts the process may +The [*Image*](/terms/image/#image-def) which starts the process may define defaults related to the binary to run, the networking to expose, and more, but `docker run` gives final control to the operator who starts the container from the image. That's the main -reason [*run*](../../commandline/cli/#cli-run) has more options than any +reason [*run*](/commandline/cli/#cli-run) has more options than any other `docker` command. -Every one of the [*Examples*](../../examples/#example-list) shows +Every one of the [*Examples*](/examples/#example-list) shows running containers, and so here we try to give more in-depth guidance. ## General Form -As you`ve seen in the [*Examples*](../../examples/#example-list), the +As you`ve seen in the [*Examples*](/examples/#example-list), the basic run command takes this form: docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...] To learn how to interpret the types of `[OPTIONS]`, -see [*Option types*](../../commandline/cli/#cli-options). +see [*Option types*](/commandline/cli/#cli-options). The list of `[OPTIONS]` breaks down into two groups: @@ -121,7 +121,7 @@ assign a name to the container with `--name` then the daemon will also generate a random string name too. The name can become a handy way to add meaning to a container since you can use this name when defining -[*links*](../../use/working_with_links_names/#working-with-links-names) +[*links*](/use/working_with_links_names/#working-with-links-names) (or any other place you need to identify a container). This works for both background and foreground Docker containers. @@ -372,7 +372,7 @@ And we can use that information to connect from another container as a client: --volumes-from="": Mount all volumes from the given container(s) The volumes commands are complex enough to have their own documentation in -section [*Share Directories via Volumes*](../../use/working_with_volumes/#volume-def). +section [*Share Directories via Volumes*](/use/working_with_volumes/#volume-def). A developer can define one or more `VOLUME's associated with an image, but only the operator can give access from one container to another (or from a container to a volume mounted on the host).