diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 38cec6ac14..3538642717 100755 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -116,11 +116,12 @@ pages: - ['jsearch.md', '**HIDDEN**'] # - ['static_files/README.md', 'static_files', 'README'] -#- ['terms/index.md', '**HIDDEN**'] -# - ['terms/layer.md', 'terms', 'layer'] -# - ['terms/index.md', 'terms', 'Home'] -# - ['terms/registry.md', 'terms', 'registry'] -# - ['terms/container.md', 'terms', 'container'] -# - ['terms/repository.md', 'terms', 'repository'] -# - ['terms/filesystem.md', 'terms', 'filesystem'] -# - ['terms/image.md', 'terms', 'image'] +- ['terms/index.md', '**HIDDEN**'] +- ['terms/layer.md', '**HIDDEN**', 'layer'] +- ['terms/index.md', '**HIDDEN**', 'Home'] +- ['terms/registry.md', '**HIDDEN**', 'registry'] +- ['terms/container.md', '**HIDDEN**', 'container'] +- ['terms/repository.md', '**HIDDEN**', 'repository'] +- ['terms/filesystem.md', '**HIDDEN**', 'filesystem'] +- ['terms/image.md', '**HIDDEN**', 'image'] + diff --git a/docs/sources/articles/baseimages.md b/docs/sources/articles/baseimages.md index 3754bab6aa..c795b7a0a7 100644 --- a/docs/sources/articles/baseimages.md +++ b/docs/sources/articles/baseimages.md @@ -5,7 +5,7 @@ page_keywords: Examples, Usage, base image, docker, documentation, examples # Create a Base Image So you want to create your own [*Base Image*]( -../../terms/image/#base-image-def)? Great! +/terms/image/#base-image-def)? Great! The specific process will depend heavily on the Linux distribution you want to package. We have some examples below, and you are encouraged to diff --git a/docs/sources/articles/security.md b/docs/sources/articles/security.md index 4519248015..69284db836 100644 --- a/docs/sources/articles/security.md +++ b/docs/sources/articles/security.md @@ -38,7 +38,7 @@ of another container. Of course, if the host system is setup accordingly, containers can interact with each other through their respective network interfaces — just like they can interact with external hosts. When you specify public ports for your containers or use -[*links*](../../use/working_with_links_names/#working-with-links-names) +[*links*](/use/working_with_links_names/#working-with-links-names) then IP traffic is allowed between containers. They can ping each other, send/receive UDP packets, and establish TCP connections, but that can be restricted if necessary. From a network architecture point of view, all diff --git a/docs/sources/examples/apt-cacher-ng.md b/docs/sources/examples/apt-cacher-ng.md index bfcf1ed232..0293ac5d0b 100644 --- a/docs/sources/examples/apt-cacher-ng.md +++ b/docs/sources/examples/apt-cacher-ng.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, networking, debian, ubuntu > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup). +> access*](/installation/binaries/#dockergroup). > - **If you're using OS X or docker via TCP** then you shouldn't use > sudo. diff --git a/docs/sources/examples/couchdb_data_volumes.md b/docs/sources/examples/couchdb_data_volumes.md index 6af8e2fd1e..10abe7af02 100644 --- a/docs/sources/examples/couchdb_data_volumes.md +++ b/docs/sources/examples/couchdb_data_volumes.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, networking, couchdb, data > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) Here's an example of using data volumes to share the same data between two CouchDB containers. This could be used for hot upgrades, testing diff --git a/docs/sources/examples/hello_world.md b/docs/sources/examples/hello_world.md index 9bcc619896..c7e821136c 100644 --- a/docs/sources/examples/hello_world.md +++ b/docs/sources/examples/hello_world.md @@ -15,7 +15,7 @@ like `/var/lib/docker/repositories: permission denied` you may have an incomplete Docker installation or insufficient privileges to access docker on your machine. -Please refer to [*Installation*](../../installation/) +Please refer to [*Installation*](/installation/) for installation instructions. ## Hello World @@ -26,7 +26,7 @@ for installation instructions. > more information please see [*Check your Docker > install*](#check-your-docker-installation). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) This is the most basic example available for using Docker. @@ -71,7 +71,7 @@ See the example in action > more information please see [*Check your Docker > install*](#check-your-docker-installation). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) And now for the most boring daemon ever written! diff --git a/docs/sources/examples/mongodb.md b/docs/sources/examples/mongodb.md index bf907891da..36a5a58ad8 100644 --- a/docs/sources/examples/mongodb.md +++ b/docs/sources/examples/mongodb.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, networking, mongodb > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) The goal of this example is to show how you can build your own Docker images with MongoDB pre-installed. We will do that by constructing a diff --git a/docs/sources/examples/nodejs_web_app.md b/docs/sources/examples/nodejs_web_app.md index 0c04836b98..f7d63dadcf 100644 --- a/docs/sources/examples/nodejs_web_app.md +++ b/docs/sources/examples/nodejs_web_app.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, node, centos > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) The goal of this example is to show you how you can build your own Docker images from a parent image using a `Dockerfile` diff --git a/docs/sources/examples/postgresql_service.md b/docs/sources/examples/postgresql_service.md index 93abc06e39..1a10cd4415 100644 --- a/docs/sources/examples/postgresql_service.md +++ b/docs/sources/examples/postgresql_service.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, postgresql > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) ## Installing PostgreSQL on Docker @@ -87,7 +87,7 @@ And run the PostgreSQL server container (in the foreground): $ sudo docker run -rm -P -name pg_test eg_postgresql There are 2 ways to connect to the PostgreSQL server. We can use [*Link -Containers*](../../use/working_with_links_names/#working-with-links-names), +Containers*](/use/working_with_links_names/#working-with-links-names), or we can access it from our host (or the network). > **Note**: diff --git a/docs/sources/examples/python_web_app.md b/docs/sources/examples/python_web_app.md index fc454a390a..e761003a9e 100644 --- a/docs/sources/examples/python_web_app.md +++ b/docs/sources/examples/python_web_app.md @@ -10,7 +10,7 @@ page_keywords: docker, example, python, web app > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) While using Dockerfiles is the preferred way to create maintainable and repeatable images, its useful to know how you can try things out and diff --git a/docs/sources/examples/running_redis_service.md b/docs/sources/examples/running_redis_service.md index 2598af2897..2bfa8a05bc 100644 --- a/docs/sources/examples/running_redis_service.md +++ b/docs/sources/examples/running_redis_service.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, networking, redis > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) Very simple, no frills, Redis service attached to a web application using a link. diff --git a/docs/sources/examples/running_riak_service.md b/docs/sources/examples/running_riak_service.md index 577ae76aa3..61594f9cd8 100644 --- a/docs/sources/examples/running_riak_service.md +++ b/docs/sources/examples/running_riak_service.md @@ -10,7 +10,7 @@ page_keywords: docker, example, package installation, networking, riak > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) The goal of this example is to show you how to build a Docker image with Riak pre-installed. diff --git a/docs/sources/examples/running_ssh_service.md b/docs/sources/examples/running_ssh_service.md index 20d5c12326..864d10c726 100644 --- a/docs/sources/examples/running_ssh_service.md +++ b/docs/sources/examples/running_ssh_service.md @@ -9,7 +9,7 @@ page_keywords: docker, example, package installation, networking > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) The following Dockerfile sets up an sshd service in a container that you can use to connect to and inspect other container's volumes, or to get diff --git a/docs/sources/examples/using_supervisord.md b/docs/sources/examples/using_supervisord.md index 6faa456080..8e85ae05d2 100644 --- a/docs/sources/examples/using_supervisord.md +++ b/docs/sources/examples/using_supervisord.md @@ -10,7 +10,7 @@ page_keywords: docker, supervisor, process management > more information please see [*Check your Docker > install*](../hello_world/#running-examples). > - **If you don't like sudo** then see [*Giving non-root -> access*](../../installation/binaries/#dockergroup) +> access*](/installation/binaries/#dockergroup) Traditionally a Docker container runs a single process when it is launched, for example an Apache daemon or a SSH server daemon. Often diff --git a/docs/sources/installation/amazon.md b/docs/sources/installation/amazon.md index 06ee65a772..61a12d6b43 100644 --- a/docs/sources/installation/amazon.md +++ b/docs/sources/installation/amazon.md @@ -59,8 +59,8 @@ add the *ubuntu* user to it so that you don't have to use `sudo` for every Docker command. Once you`ve got Docker installed, you're ready to try it out – head on -over to the [*First steps with Docker*](../../use/basics/) or -[*Examples*](../../examples/) section. +over to the [*First steps with Docker*](/use/basics/) or +[*Examples*](/examples/) section. ## Amazon QuickStart (Release Candidate - March 2014) @@ -100,4 +100,4 @@ QuickStart*](#amazon-quickstart) to pick an image (or use one of your own) and skip the step with the *User Data*. Then continue with the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) instructions. -Continue with the [*Hello World*](../../examples/hello_world/#hello-world) example. +Continue with the [*Hello World*](/examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/binaries.md b/docs/sources/installation/binaries.md index f33508c9d7..b02c28828b 100644 --- a/docs/sources/installation/binaries.md +++ b/docs/sources/installation/binaries.md @@ -80,7 +80,7 @@ all the client commands. > **Warning**: > The *docker* group (or the group specified with `-G`) is root-equivalent; > see [*Docker Daemon Attack Surface*]( -> ../../articles/security/#dockersecurity-daemon) details. +> /articles/security/#dockersecurity-daemon) details. ## Upgrades @@ -99,4 +99,4 @@ Then follow the regular installation steps. # run a container and open an interactive shell in the container sudo ./docker run -i -t ubuntu /bin/bash -Continue with the [*Hello World*](../../examples/hello_world/#hello-world) example. +Continue with the [*Hello World*](/examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/fedora.md b/docs/sources/installation/fedora.md index bd82674b01..70d8c1462e 100644 --- a/docs/sources/installation/fedora.md +++ b/docs/sources/installation/fedora.md @@ -61,4 +61,4 @@ Now let's verify that Docker is working. sudo docker run -i -t fedora /bin/bash **Done!**, now continue with the [*Hello -World*](../../examples/hello_world/#hello-world) example. +World*](/examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 71fd9f5fed..1cef06b55b 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -143,7 +143,7 @@ If you feel the need to connect to the VM, you can simply run: # Pwd: tcuser You can now continue with the [*Hello -World*](../../examples/hello_world/#hello-world) example. +World*](/examples/hello_world/#hello-world) example. ## Learn More diff --git a/docs/sources/installation/openSUSE.md b/docs/sources/installation/openSUSE.md index b4fa9183a5..2d7804d291 100644 --- a/docs/sources/installation/openSUSE.md +++ b/docs/sources/installation/openSUSE.md @@ -61,4 +61,4 @@ Docker daemon. **Done!** Now continue with the [*Hello World*]( -../../examples/hello_world/#hello-world) example. +/examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/rhel.md b/docs/sources/installation/rhel.md index 715cca74a2..874e92adc8 100644 --- a/docs/sources/installation/rhel.md +++ b/docs/sources/installation/rhel.md @@ -68,7 +68,7 @@ Now let's verify that Docker is working. sudo docker run -i -t fedora /bin/bash **Done!** -Now continue with the [*Hello World*](../../examples/hello_world/#hello-world) example. +Now continue with the [*Hello World*](/examples/hello_world/#hello-world) example. ## Issues? diff --git a/docs/sources/installation/softlayer.md b/docs/sources/installation/softlayer.md index 6468829594..11a192c61a 100644 --- a/docs/sources/installation/softlayer.md +++ b/docs/sources/installation/softlayer.md @@ -33,4 +33,4 @@ page_keywords: IBM SoftLayer, virtualization, cloud, docker, documentation, inst instructions. Continue with the [*Hello World*]( -../../examples/hello_world/#hello-world) example. +/examples/hello_world/#hello-world) example. diff --git a/docs/sources/installation/ubuntulinux.md b/docs/sources/installation/ubuntulinux.md index c4152ec1c4..40dc541b6a 100644 --- a/docs/sources/installation/ubuntulinux.md +++ b/docs/sources/installation/ubuntulinux.md @@ -96,7 +96,7 @@ Now verify that the installation has worked by downloading the Type `exit` to exit **Done!**, now continue with the [*Hello -World*](../../examples/hello_world/#hello-world) example. +World*](/examples/hello_world/#hello-world) example. ## Ubuntu Raring 13.04 and Saucy 13.10 (64 bit) @@ -144,7 +144,7 @@ Now verify that the installation has worked by downloading the Type `exit` to exit **Done!**, now continue with the [*Hello -World*](../../examples/hello_world/#hello-world) example. +World*](/examples/hello_world/#hello-world) example. ### Giving non-root access @@ -168,7 +168,7 @@ than `docker` should own the Unix socket with the > **Warning**: > The *docker* group (or the group specified with `-G`) is > root-equivalent; see [*Docker Daemon Attack Surface*]( -> ../../articles/security/#dockersecurity-daemon) details. +> /articles/security/#dockersecurity-daemon) details. **Example:** diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.6.md b/docs/sources/reference/api/archive/docker_remote_api_v1.6.md index 47c2b82e27..2ec7336a75 100644 --- a/docs/sources/reference/api/archive/docker_remote_api_v1.6.md +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.6.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -540,7 +540,7 @@ Attach to the container `id` When using the TTY setting is enabled in [`POST /containers/create` - ](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + ](/api/docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), the stream is the raw data from the process PTY and client's stdin. When the TTY is disabled, then the stream is multiplexed to separate stdout and stderr. diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.7.md b/docs/sources/reference/api/archive/docker_remote_api_v1.7.md index ccc973925a..cf748a7f9b 100644 --- a/docs/sources/reference/api/archive/docker_remote_api_v1.7.md +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.7.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -489,7 +489,7 @@ Attach to the container `id` When using the TTY setting is enabled in [`POST /containers/create` - ](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + ](/api/docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), the stream is the raw data from the process PTY and client's stdin. When the TTY is disabled, then the stream is multiplexed to separate stdout and stderr. @@ -980,7 +980,7 @@ Build an image from Dockerfile via stdin The archive must include a file called `Dockerfile` at its root. It may include any number of other files, which will be accessible in the build context (See the [*ADD build - command*](../../../builder/#dockerbuilder)). + command*](/builder/#dockerbuilder)). Query Parameters: diff --git a/docs/sources/reference/api/archive/docker_remote_api_v1.8.md b/docs/sources/reference/api/archive/docker_remote_api_v1.8.md index 4bc4d01638..8520e9f1e5 100644 --- a/docs/sources/reference/api/archive/docker_remote_api_v1.8.md +++ b/docs/sources/reference/api/archive/docker_remote_api_v1.8.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -531,7 +531,7 @@ Attach to the container `id` When using the TTY setting is enabled in [`POST /containers/create` - ](../../docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), + ](/api/docker_remote_api_v1.9/#post--containers-create "POST /containers/create"), the stream is the raw data from the process PTY and client's stdin. When the TTY is disabled, then the stream is multiplexed to separate stdout and stderr. @@ -1024,7 +1024,7 @@ Build an image from Dockerfile via stdin The archive must include a file called `Dockerfile` at its root. It may include any number of other files, which will be accessible in the build context (See the [*ADD build - command*](../../../builder/#dockerbuilder)). + command*](/reference/builder/#dockerbuilder)). Query Parameters: diff --git a/docs/sources/reference/api/docker_io_oauth_api.md b/docs/sources/reference/api/docker_io_oauth_api.md index 6cc4a6d546..dd2f6d75ec 100644 --- a/docs/sources/reference/api/docker_io_oauth_api.md +++ b/docs/sources/reference/api/docker_io_oauth_api.md @@ -96,7 +96,7 @@ an Authorization Code. prompt which asks the user to authorize your application with a description of the requested scopes. - ![](../../../static_files/io_oauth_authorization_page.png) + ![](/reference/api/_static/io_oauth_authorization_page.png) Once the user allows or denies your Authorization Request the user will be redirected back to your application. Included in that diff --git a/docs/sources/reference/api/docker_remote_api_v1.10.md b/docs/sources/reference/api/docker_remote_api_v1.10.md index 474857bac3..c07f96f384 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.10.md +++ b/docs/sources/reference/api/docker_remote_api_v1.10.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -1009,7 +1009,7 @@ Build an image from Dockerfile via stdin The archive must include a file called `Dockerfile` at its root. It may include any number of other files, which will be accessible in the build context (See the [*ADD build - command*](../../builder/#dockerbuilder)). + command*](/reference/builder/#dockerbuilder)). Query Parameters: diff --git a/docs/sources/reference/api/docker_remote_api_v1.11.md b/docs/sources/reference/api/docker_remote_api_v1.11.md index af47fdefbf..5e3fdcb0a8 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.11.md +++ b/docs/sources/reference/api/docker_remote_api_v1.11.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -1012,7 +1012,7 @@ Build an image from Dockerfile via stdin The archive must include a file called `Dockerfile` at its root. It may include any number of other files, which will be accessible in the build context (See the [*ADD build - command*](../../builder/#dockerbuilder)). + command*](/reference/builder/#dockerbuilder)). Query Parameters: diff --git a/docs/sources/reference/api/docker_remote_api_v1.9.md b/docs/sources/reference/api/docker_remote_api_v1.9.md index be1c76aee4..74e85a7ee6 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.9.md +++ b/docs/sources/reference/api/docker_remote_api_v1.9.md @@ -9,7 +9,7 @@ page_keywords: API, Docker, rcli, REST, documentation - The Remote API has replaced rcli - The daemon listens on `unix:///var/run/docker.sock` but you can [*Bind Docker to another host/port or a Unix socket*]( - ../../../use/basics/#bind-docker). + /use/basics/#bind-docker). - The API tends to be REST, but for some complex commands, like `attach` or `pull`, the HTTP connection is hijacked to transport `stdout, stdin` and `stderr` @@ -1022,7 +1022,7 @@ Build an image from Dockerfile using a POST body. The archive must include a file called `Dockerfile` at its root. It may include any number of other files, which will be accessible in the build context (See the [*ADD build - command*](../../builder/#dockerbuilder)). + command*](/reference/builder/#dockerbuilder)). Query Parameters: diff --git a/docs/sources/reference/api/registry_index_spec.md b/docs/sources/reference/api/registry_index_spec.md index ab775b2237..fb5617d101 100644 --- a/docs/sources/reference/api/registry_index_spec.md +++ b/docs/sources/reference/api/registry_index_spec.md @@ -95,7 +95,7 @@ supports: ### Pull -![](../../../static_files/docker_pull_chart.png) +![](/static_files/docker_pull_chart.png) 1. Contact the Index to know where I should download “samalba/busybox” 2. Index replies: a. `samalba/busybox` is on Registry A b. here are the @@ -187,7 +187,7 @@ and for an active account. ### Push -![](../../../static_files/docker_push_chart.png) +![](/static_files/docker_push_chart.png) 1. Contact the index to allocate the repository name “samalba/busybox” (authentication required with user credentials) diff --git a/docs/sources/reference/builder.md b/docs/sources/reference/builder.md index c976c118d7..3e278425c2 100644 --- a/docs/sources/reference/builder.md +++ b/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/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index d59bd37674..6388cb6192 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/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/docs/sources/reference/run.md b/docs/sources/reference/run.md index f6f132a09d..9de08ec1a6 100644 --- a/docs/sources/reference/run.md +++ b/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). diff --git a/docs/sources/terms/container.md b/docs/sources/terms/container.md index d7f139a3ca..5bedc3160e 100644 --- a/docs/sources/terms/container.md +++ b/docs/sources/terms/container.md @@ -6,7 +6,7 @@ page_keywords: containers, lxc, concepts, explanation, image, container ## Introduction -![](../../static_files/docker-filesystems-busyboxrw.png) +![](/terms/images/docker-filesystems-busyboxrw.png) Once you start a process in Docker from an [*Image*](image.md), Docker fetches the image and its [*Parent Image*](image.md), and repeats the process until it diff --git a/docs/sources/terms/filesystem.md b/docs/sources/terms/filesystem.md index 07f75e361e..5587e3c831 100644 --- a/docs/sources/terms/filesystem.md +++ b/docs/sources/terms/filesystem.md @@ -6,7 +6,7 @@ page_keywords: containers, files, linux ## Introduction -![](../../static_files/docker-filesystems-generic.png) +![](/terms/images/docker-filesystems-generic.png) In order for a Linux system to run, it typically needs two [file systems](http://en.wikipedia.org/wiki/Filesystem): @@ -32,4 +32,4 @@ usually what make your software packages dependent on one distribution versus another. Docker can help solve this problem by running multiple distributions at the same time. -![](../../static_files/docker-filesystems-multiroot.png) +![](/terms/images/docker-filesystems-multiroot.png) diff --git a/docs/sources/terms/image.md b/docs/sources/terms/image.md index 031dd2e978..b10debcc6a 100644 --- a/docs/sources/terms/image.md +++ b/docs/sources/terms/image.md @@ -6,7 +6,7 @@ page_keywords: containers, lxc, concepts, explanation, image, container ## Introduction -![](../../static_files/docker-filesystems-debian.png) +![](/terms/images/docker-filesystems-debian.png) In Docker terminology, a read-only [*Layer*](../layer/#layer-def) is called an **image**. An image never changes. @@ -17,11 +17,11 @@ changes go to the top-most writeable layer, and underneath, the original file in the read-only image is unchanged. Since images don't change, images do not have state. -![](../../static_files/docker-filesystems-debianrw.png) +![](/terms/images/docker-filesystems-debianrw.png) ## Parent Image -![](../../static_files/docker-filesystems-multilayer.png) +![](/terms/images/docker-filesystems-multilayer.png) Each image may depend on one more image which forms the layer beneath it. We sometimes say that the lower image is the **parent** of the upper diff --git a/docs/sources/terms/layer.md b/docs/sources/terms/layer.md index 39c71fa4b6..b4b2ea4b7a 100644 --- a/docs/sources/terms/layer.md +++ b/docs/sources/terms/layer.md @@ -20,7 +20,7 @@ file system *over* the read-only file system. In fact there may be multiple read-only file systems stacked on top of each other. We think of each one of these file systems as a **layer**. -![](../../static_files/docker-filesystems-multilayer.png) +![](/terms/images/docker-filesystems-multilayer.png) At first, the top read-write layer has nothing in it, but any time a process creates a file, this happens in the top layer. And if something diff --git a/docs/sources/use/basics.md b/docs/sources/use/basics.md index 2d1bf34f96..bbe967cc7c 100644 --- a/docs/sources/use/basics.md +++ b/docs/sources/use/basics.md @@ -17,7 +17,7 @@ like `/var/lib/docker/repositories: permission denied` you may have an incomplete docker installation or insufficient privileges to access Docker on your machine. -Please refer to [*Installation*](../../installation/#installation-list) +Please refer to [*Installation*](/installation/#installation-list) for installation instructions. ## Download a pre-built image @@ -172,4 +172,4 @@ You now have a image state from which you can create new instances. Read more about [*Share Images via Repositories*]( ../workingwithrepository/#working-with-the-repository) or -continue to the complete [*Command Line*](../../reference/commandline/cli/#cli) +continue to the complete [*Command Line*](/reference/commandline/cli/#cli) diff --git a/docs/sources/use/chef.md b/docs/sources/use/chef.md index 476b2919d0..5145107a38 100644 --- a/docs/sources/use/chef.md +++ b/docs/sources/use/chef.md @@ -7,7 +7,7 @@ page_keywords: chef, installation, usage, docker, documentation > **Note**: > Please note this is a community contributed installation path. The only > `official` installation is using the -> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +> [*Ubuntu*](/installation/ubuntulinux/#ubuntu-linux) installation > path. This version may sometimes be out of date. ## Requirements diff --git a/docs/sources/use/puppet.md b/docs/sources/use/puppet.md index 026b1defb1..c1ac95f4ab 100644 --- a/docs/sources/use/puppet.md +++ b/docs/sources/use/puppet.md @@ -6,7 +6,7 @@ page_keywords: puppet, installation, usage, docker, documentation > *Note:* Please note this is a community contributed installation path. The > only `official` installation is using the -> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +> [*Ubuntu*](/installation/ubuntulinux/#ubuntu-linux) installation > path. This version may sometimes be out of date. ## Requirements diff --git a/docs/sources/use/working_with_volumes.md b/docs/sources/use/working_with_volumes.md index 4712a9fbff..5817309e62 100644 --- a/docs/sources/use/working_with_volumes.md +++ b/docs/sources/use/working_with_volumes.md @@ -8,7 +8,7 @@ page_keywords: Examples, Usage, volume, docker, documentation, examples A *data volume* is a specially-designated directory within one or more containers that bypasses the [*Union File -System*](../../terms/layer/#ufs-def) to provide several useful features +System*](/terms/layer/#ufs-def) to provide several useful features for persistent or shared data: - **Data volumes can be shared and reused between containers:** @@ -20,7 +20,7 @@ for persistent or shared data: very large files. - **Changes to a data volume will not be included at the next commit:** Because they are not recorded as regular filesystem changes in the - top layer of the [*Union File System*](../../terms/layer/#ufs-def) + top layer of the [*Union File System*](/terms/layer/#ufs-def) - **Volumes persist until no containers use them:** As they are a reference counted resource. The container does not need to be running to share its volumes, but running it can help protect it diff --git a/docs/sources/use/workingwithrepository.md b/docs/sources/use/workingwithrepository.md index 38eda476ed..2ffca34ce5 100644 --- a/docs/sources/use/workingwithrepository.md +++ b/docs/sources/use/workingwithrepository.md @@ -7,7 +7,7 @@ page_keywords: repo, repositories, usage, pull image, push image, image, documen ## Introduction A *repository* is a shareable collection of tagged -[*images*](../../terms/image/#image-def) that together create the file +[*images*](/terms/image/#image-def) that together create the file systems for containers. The repository's name is a label that indicates the provenance of the repository, i.e. who created it and where the original copy is located. @@ -19,7 +19,7 @@ the home of "top-level" repositories and the Central Index. This registry may also include public "user" repositories. Docker is not only a tool for creating and managing your own -[*containers*](../../terms/container/#container-def) – **Docker is also +[*containers*](/terms/container/#container-def) – **Docker is also a tool for sharing**. The Docker project provides a Central Registry to host public repositories, namespaced by user, and a Central Index which provides user authentication and search over all the public @@ -89,7 +89,7 @@ Once you have found the image name, you can download it: 539c0211cd76: Download complete What can you do with that image? Check out the -[*Examples*](../../examples/#example-list) and, when you're ready with +[*Examples*](/examples/#example-list) and, when you're ready with your own image, come back here to learn how to share it. ## Contributing to the Central Registry