diff --git a/docs/sources/contributing/devenvironment.md b/docs/sources/contributing/devenvironment.md index 41c527cde5..6551d9fbac 100644 --- a/docs/sources/contributing/devenvironment.md +++ b/docs/sources/contributing/devenvironment.md @@ -68,10 +68,8 @@ on ubuntu: sudo service docker stop ; sudo cp $(which docker) $(which docker)_ ; sudo cp ./bundles/-dev/binary/docker--dev $(which docker);sudo service docker start -Note - -Its safer to run the tests below before swapping your hosts docker -binary. +> **Note**: +> Its safer to run the tests below before swapping your hosts docker binary. ## Run the Tests diff --git a/docs/sources/examples/apt-cacher-ng.md b/docs/sources/examples/apt-cacher-ng.md index 8749568ac9..c7fee5542a 100644 --- a/docs/sources/examples/apt-cacher-ng.md +++ b/docs/sources/examples/apt-cacher-ng.md @@ -4,15 +4,15 @@ page_keywords: docker, example, package installation, networking, debian, ubuntu # Apt-Cacher-ng Service -Note - -- This example assumes you have Docker running in daemon mode. For - 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) -- **If you’re using OS X or docker via TCP** then you shouldn’t use - sudo +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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). +> - **If you’re using OS X or docker via TCP** then you shouldn’t use +> sudo. When you have multiple Docker servers, or build unrelated Docker containers which can’t make use of the Docker build cache, it can be diff --git a/docs/sources/examples/couchdb_data_volumes.md b/docs/sources/examples/couchdb_data_volumes.md index 363c3f22f8..1b18cf0aa7 100644 --- a/docs/sources/examples/couchdb_data_volumes.md +++ b/docs/sources/examples/couchdb_data_volumes.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, networking, couchdb, data # CouchDB Service -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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 42fd5d46e1..062d5d37b3 100644 --- a/docs/sources/examples/hello_world.md +++ b/docs/sources/examples/hello_world.md @@ -20,13 +20,13 @@ for installation instructions. ## Hello World -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) This is the most basic example available for using Docker. @@ -66,13 +66,13 @@ See the example in action ## Hello World Daemon -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) And now for the most boring daemon ever written! diff --git a/docs/sources/examples/https.md b/docs/sources/examples/https.md index 30fd8f2ea9..153a6c0cf9 100644 --- a/docs/sources/examples/https.md +++ b/docs/sources/examples/https.md @@ -15,10 +15,9 @@ In daemon mode, it will only allow connections from clients authenticated by a certificate signed by that CA. In client mode, it will only connect to servers with a certificate signed by that CA. -Warning - -Using TLS and managing a CA is an advanced topic. Please make you self -familiar with openssl, x509 and tls before using it in production. +> **Warning**: +> Using TLS and managing a CA is an advanced topic. Please make you self +> familiar with openssl, x509 and tls before using it in production. ## Create a CA, server and client keys with OpenSSL @@ -76,15 +75,14 @@ need to provide your client keys, certificates and trusted CA: $ docker --tlsverify --tlscacert=ca.pem --tlscert=client-cert.pem --tlskey=client-key.pem \ -H=dns-name-of-docker-host:4243 -Warning - -As shown in the example above, you don’t have to run the -`docker` client with `sudo` or -the `docker` group when you use certificate -authentication. That means anyone with the keys can give any -instructions to your Docker daemon, giving them root access to the -machine hosting the daemon. Guard these keys as you would a root -password! +> **Warning**: +> As shown in the example above, you don’t have to run the +> `docker` client with `sudo` or +> the `docker` group when you use certificate +> authentication. That means anyone with the keys can give any +> instructions to your Docker daemon, giving them root access to the +> machine hosting the daemon. Guard these keys as you would a root +> password! ## Other modes diff --git a/docs/sources/examples/mongodb.md b/docs/sources/examples/mongodb.md index 6612bf3ce5..c9078419d6 100644 --- a/docs/sources/examples/mongodb.md +++ b/docs/sources/examples/mongodb.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, networking, mongodb # Building an Image with MongoDB -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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 df43ad0b5e..77d75047b6 100644 --- a/docs/sources/examples/nodejs_web_app.md +++ b/docs/sources/examples/nodejs_web_app.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, node, centos # Node.js Web App -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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 a15d3c2ff0..053bf410c0 100644 --- a/docs/sources/examples/postgresql_service.md +++ b/docs/sources/examples/postgresql_service.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, postgresql # PostgreSQL Service -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) ## Installing PostgreSQL on Docker @@ -19,11 +19,10 @@ index](http://index.docker.io), you can create one yourself. Start by creating a new Dockerfile: -Note - -This PostgreSQL setup is for development only purposes. Refer to the -PostgreSQL documentation to fine-tune these settings so that it is -suitably secure. +> **Note**: +> This PostgreSQL setup is for development only purposes. Refer to the +> PostgreSQL documentation to fine-tune these settings so that it is +> suitably secure. # # example Dockerfile for http://docs.docker.io/en/latest/examples/postgresql_service/ @@ -91,10 +90,9 @@ There are 2 ways to connect to the PostgreSQL server. We can use [*Link Containers*](../../use/working_with_links_names/#working-with-links-names), or we can access it from our host (or the network). -Note - -The `-rm` removes the container and its image when -the container exists successfully. +> **Note**: +> The `-rm` removes the container and its image when +> the container exists successfully. ### Using container linking diff --git a/docs/sources/examples/python_web_app.md b/docs/sources/examples/python_web_app.md index 0c286335b6..2212f97139 100644 --- a/docs/sources/examples/python_web_app.md +++ b/docs/sources/examples/python_web_app.md @@ -4,13 +4,13 @@ page_keywords: docker, example, python, web app # Python Web App -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) While using Dockerfiles is the preferred way to create maintainable and repeatable images, its useful to know how you can try things out and @@ -33,12 +33,11 @@ modules, and a `runapp` script that finds the $ sudo docker pull shykes/pybuilder -Note - -This container was built with a very old version of docker (May 2013 - -see [shykes/pybuilder](https://github.com/shykes/pybuilder) ), when the -`Dockerfile` format was different, but the image can -still be used now. +> **Note**: +> This container was built with a very old version of docker (May 2013 - +> see [shykes/pybuilder](https://github.com/shykes/pybuilder) ), when the +> `Dockerfile` format was different, but the image can +> still be used now. ## Interactively make some modifications diff --git a/docs/sources/examples/running_redis_service.md b/docs/sources/examples/running_redis_service.md index 38892eeb55..b67937fab5 100644 --- a/docs/sources/examples/running_redis_service.md +++ b/docs/sources/examples/running_redis_service.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, networking, redis # Redis Service -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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 f046f53452..ad0b20a628 100644 --- a/docs/sources/examples/running_riak_service.md +++ b/docs/sources/examples/running_riak_service.md @@ -4,13 +4,13 @@ page_keywords: docker, example, package installation, networking, riak # Riak Service -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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/using_supervisord.md b/docs/sources/examples/using_supervisord.md index 8545b0471f..3a0793710f 100644 --- a/docs/sources/examples/using_supervisord.md +++ b/docs/sources/examples/using_supervisord.md @@ -4,13 +4,13 @@ page_keywords: docker, supervisor, process management # Using Supervisor with Docker -Note - -- This example assumes you have Docker running in daemon mode. For - 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) +> **Note**: +> +> - This example assumes you have Docker running in daemon mode. For +> 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) 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/faq.md b/docs/sources/faq.md index 4220ee025c..563e07a1c7 100644 --- a/docs/sources/faq.md +++ b/docs/sources/faq.md @@ -42,7 +42,7 @@ page_keywords: faq, questions, documentation, docker > features, Docker offers a high-level tool with several powerful > functionalities: > -> - *Portable deployment across machines.* +> - *Portable deployment across machines.* > : Docker defines a format for bundling an application and all > its dependencies into a single object which can be transferred > to any Docker-enabled machine, and executed there with the @@ -59,7 +59,7 @@ page_keywords: faq, questions, documentation, docker > exact same Docker container can run - unchanged - on many > different machines, with many different configurations. > -> - *Application-centric.* +> - *Application-centric.* > : Docker is optimized for the deployment of applications, as > opposed to machines. This is reflected in its API, user > interface, design philosophy and documentation. By contrast, @@ -68,7 +68,7 @@ page_keywords: faq, questions, documentation, docker > boot faster and need less RAM. We think there’s more to > containers than just that. > -> - *Automatic build.* +> - *Automatic build.* > : Docker includes [*a tool for developers to automatically > assemble a container from their source > code*](../reference/builder/#dockerbuilder), with full control @@ -78,7 +78,7 @@ page_keywords: faq, questions, documentation, docker > packages, RPMs, source tarballs, or any combination of the > above, regardless of the configuration of the machines. > -> - *Versioning.* +> - *Versioning.* > : Docker includes git-like capabilities for tracking successive > versions of a container, inspecting the diff between versions, > committing new versions, rolling back etc. The history also @@ -89,7 +89,7 @@ page_keywords: faq, questions, documentation, docker > , so new versions of a container can be transferred > by only sending diffs. > -> - *Component re-use.* +> - *Component re-use.* > : Any container can be used as a [*"base > image"*](../terms/image/#base-image-def) to create more > specialized components. This can be done manually or as part @@ -98,7 +98,7 @@ page_keywords: faq, questions, documentation, docker > applications. Your ideal Postgresql setup can be re-used for > all your future projects. And so on. > -> - *Sharing.* +> - *Sharing.* > : Docker has access to a [public > registry](http://index.docker.io) where thousands of people > have uploaded useful containers: anything from Redis, CouchDB, @@ -111,7 +111,7 @@ page_keywords: faq, questions, documentation, docker > store and transfer private containers, for internal server > deployments for example. > -> - *Tool ecosystem.* +> - *Tool ecosystem.* > : Docker defines an API for automating and customizing the > creation and deployment of containers. There are a huge number > of tools integrating with Docker to extend its capabilities. @@ -202,17 +202,17 @@ sources. ### Where can I find more answers? -> You can find more answers on: -> -> - [Docker user -> mailinglist](https://groups.google.com/d/forum/docker-user) -> - [Docker developer -> mailinglist](https://groups.google.com/d/forum/docker-dev) -> - [IRC, docker on freenode](irc://chat.freenode.net#docker) -> - [GitHub](http://www.github.com/dotcloud/docker) -> - [Ask questions on -> Stackoverflow](http://stackoverflow.com/search?q=docker) -> - [Join the conversation on Twitter](http://twitter.com/docker) +You can find more answers on: + +- [Docker user + mailinglist](https://groups.google.com/d/forum/docker-user) +- [Docker developer + mailinglist](https://groups.google.com/d/forum/docker-dev) +- [IRC, docker on freenode](irc://chat.freenode.net#docker) +- [GitHub](http://www.github.com/dotcloud/docker) +- [Ask questions on + Stackoverflow](http://stackoverflow.com/search?q=docker) +- [Join the conversation on Twitter](http://twitter.com/docker) Looking for something else to read? Checkout the [*Hello World*](../examples/hello_world/#hello-world) example. diff --git a/docs/sources/index.md b/docs/sources/index.md index 6c789eae47..42f3286352 100644 --- a/docs/sources/index.md +++ b/docs/sources/index.md @@ -72,10 +72,11 @@ and see: > [Click here to go to Get Docker](introduction/get-docker.md). -**Note**: We know how valuable your time is. Therefore, the -documentation is prepared in a way to allow anyone to start from any -section need. Although we strongly recommend that you visit -[Understanding Docker](introduction/understanding-docker.md) to see how Docker is -different, if you already have some knowledge and want to quickly get -started with Docker, don't hesitate to jump to [Working with -Docker](introduction/working-with-docker.md). +> **Note**: +> We know how valuable your time is. Therefore, the documentation is prepared +> in a way to allow anyone to start from any section need. Although we strongly +> recommend that you visit [Understanding Docker]( +> introduction/understanding-docker.md) to see how Docker is different, if you +> already have some knowledge and want to quickly get started with Docker, +> don't hesitate to jump to [Working with Docker]( +> introduction/working-with-docker.md). diff --git a/docs/sources/index/builds.md b/docs/sources/index/builds.md index d8fe09a111..899971c201 100644 --- a/docs/sources/index/builds.md +++ b/docs/sources/index/builds.md @@ -85,7 +85,8 @@ page. If you have a `README.md` file in your repository, we will use that as the repository's full description. -> **Warning:** If you change the full description after a build, it will be +> **Warning:** +> If you change the full description after a build, it will be > rewritten the next time the Trusted Build has been built. To make changes, > modify the README.md from the Git repository. We will look for a README.md > in the same directory as your Dockerfile. @@ -97,7 +98,8 @@ can setup a build trigger. When you turn on the build trigger for a Trusted Build, it will give you a URL to which you can send POST requests. This will trigger the Trusted Build process, which is similar to GitHub webhooks. -> **Note:** You can only trigger one build at a time and no more than one +> **Note:** +> You can only trigger one build at a time and no more than one > every five minutes. If you have a build already pending, or if you already > recently submitted a build request, those requests *will be ignored*. > You can find the logs of last 10 triggers on the settings page to verify @@ -113,6 +115,7 @@ To add a link, go to the settings page of a Trusted Build and click on *Repository Links*. Then enter the name of the repository that you want have linked. -> **Warning:** You can add more than one repository link, however, you should +> **Warning:** +> You can add more than one repository link, however, you should > be very careful. Creating a two way relationship between Trusted Builds will > cause a never ending build loop. diff --git a/docs/sources/installation/amazon.md b/docs/sources/installation/amazon.md index 88903bb1cf..f97c8fde9e 100644 --- a/docs/sources/installation/amazon.md +++ b/docs/sources/installation/amazon.md @@ -4,12 +4,11 @@ page_keywords: amazon ec2, virtualization, cloud, docker, documentation, install # Amazon EC2 -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) There are several ways to install Docker on AWS EC2: diff --git a/docs/sources/installation/archlinux.md b/docs/sources/installation/archlinux.md index ac0aea8a24..3eebdecdc8 100644 --- a/docs/sources/installation/archlinux.md +++ b/docs/sources/installation/archlinux.md @@ -4,19 +4,17 @@ page_keywords: arch linux, virtualization, docker, documentation, installation # Arch Linux -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Installing on Arch Linux can be handled via the package in community: diff --git a/docs/sources/installation/binaries.md b/docs/sources/installation/binaries.md index dbe79c983c..70679b6649 100644 --- a/docs/sources/installation/binaries.md +++ b/docs/sources/installation/binaries.md @@ -4,12 +4,11 @@ page_keywords: binaries, installation, docker, documentation, linux # Binaries -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) **This instruction set is meant for hackers who want to try out Docker on a variety of environments.** @@ -49,11 +48,11 @@ Linux kernel (it even builds on OSX!). wget https://get.docker.io/builds/Linux/x86_64/docker-latest -O docker chmod +x docker -Note - -If you have trouble downloading the binary, you can also get the smaller -compressed release file: -[https://get.docker.io/builds/Linux/x86\_64/docker-latest.tgz](https://get.docker.io/builds/Linux/x86_64/docker-latest.tgz) +> **Note**: +> If you have trouble downloading the binary, you can also get the smaller +> compressed release file: +> [https://get.docker.io/builds/Linux/x86\_64/docker-latest.tgz]( +> https://get.docker.io/builds/Linux/x86_64/docker-latest.tgz) ## Run the docker daemon @@ -77,11 +76,10 @@ but if you run the `docker` client as a user in the *docker* group then you don’t need to add `sudo` to all the client commands. -Warning - -The *docker* group (or the group specified with `-G` -.literal}) is root-equivalent; see [*Docker Daemon Attack -Surface*](../../articles/security/#dockersecurity-daemon) details. +> **Warning**: +> The *docker* group (or the group specified with `-G`) is root-equivalent; +> see [*Docker Daemon Attack Surface*]( +> ../../articles/security/#dockersecurity-daemon) details. ## Upgrades diff --git a/docs/sources/installation/cruxlinux.md b/docs/sources/installation/cruxlinux.md index 92b85cfcbc..9bb336a6f5 100644 --- a/docs/sources/installation/cruxlinux.md +++ b/docs/sources/installation/cruxlinux.md @@ -4,19 +4,17 @@ page_keywords: crux linux, virtualization, Docker, documentation, installation # CRUX Linux -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published. Installing on CRUX Linux can be handled via the ports from [James Mills](http://prologic.shortcircuit.net.au/): diff --git a/docs/sources/installation/fedora.md b/docs/sources/installation/fedora.md index 295774f718..0718df032c 100644 --- a/docs/sources/installation/fedora.md +++ b/docs/sources/installation/fedora.md @@ -4,19 +4,17 @@ page_keywords: Docker, Docker documentation, Fedora, requirements, virtualbox, v # Fedora -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published. Docker is available in **Fedora 19 and later**. Please note that due to the current Docker limitations Docker is able to run only on the **64 diff --git a/docs/sources/installation/frugalware.md b/docs/sources/installation/frugalware.md index 45bba0619f..0e9f9c9f1b 100644 --- a/docs/sources/installation/frugalware.md +++ b/docs/sources/installation/frugalware.md @@ -4,19 +4,17 @@ page_keywords: frugalware linux, virtualization, docker, documentation, installa # FrugalWare -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Installing on FrugalWare is handled via the official packages: diff --git a/docs/sources/installation/gentoolinux.md b/docs/sources/installation/gentoolinux.md index 1104ecdebb..87e1c78e84 100644 --- a/docs/sources/installation/gentoolinux.md +++ b/docs/sources/installation/gentoolinux.md @@ -4,19 +4,17 @@ page_keywords: gentoo linux, virtualization, docker, documentation, installation # Gentoo -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Installing Docker on Gentoo Linux can be accomplished using one of two methods. The first and best way if you’re looking for a stable diff --git a/docs/sources/installation/google.md b/docs/sources/installation/google.md index 2fa2acac2c..611e9bb7bc 100644 --- a/docs/sources/installation/google.md +++ b/docs/sources/installation/google.md @@ -4,12 +4,11 @@ page_keywords: Docker, Docker documentation, installation, google, Google Comput # [Google Cloud Platform](https://cloud.google.com/) -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) ## [Compute Engine](https://developers.google.com/compute) QuickStart for [Debian](https://www.debian.org) diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 9d6c6892bc..d21075b5f8 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -4,17 +4,15 @@ page_keywords: Docker, Docker documentation, requirements, virtualbox, ssh, linu # Mac OS X -Note +> **Note**: +> These instructions are available with the new release of Docker (version +> 0.8). However, they are subject to change. -These instructions are available with the new release of Docker (version -0.8). However, they are subject to change. - -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) Docker is supported on Mac OS X 10.6 "Snow Leopard" or newer. diff --git a/docs/sources/installation/openSUSE.md b/docs/sources/installation/openSUSE.md index d0aad1cd54..ebd8ea6f6e 100644 --- a/docs/sources/installation/openSUSE.md +++ b/docs/sources/installation/openSUSE.md @@ -4,19 +4,17 @@ page_keywords: openSUSE, virtualbox, docker, documentation, installation # openSUSE -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Docker is available in **openSUSE 12.3 and later**. Please note that due to the current Docker limitations Docker is able to run only on the **64 diff --git a/docs/sources/installation/rackspace.md b/docs/sources/installation/rackspace.md index a4366638d5..2d213a7fc9 100644 --- a/docs/sources/installation/rackspace.md +++ b/docs/sources/installation/rackspace.md @@ -4,12 +4,11 @@ page_keywords: Rackspace Cloud, installation, docker, linux, ubuntu # Rackspace Cloud -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Installing Docker on Ubuntu provided by Rackspace is pretty straightforward, and you should mostly be able to follow the diff --git a/docs/sources/installation/rhel.md b/docs/sources/installation/rhel.md index d17293f3a5..d7df63920d 100644 --- a/docs/sources/installation/rhel.md +++ b/docs/sources/installation/rhel.md @@ -4,19 +4,17 @@ page_keywords: Docker, Docker documentation, requirements, linux, rhel, centos # Red Hat Enterprise Linux -Note +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) - -Note - -This is a community contributed installation path. The only ‘official’ -installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) -installation path. This version may be out of date because it depends on -some binaries to be updated and published +> **Note**: +> This is a community contributed installation path. The only ‘official’ +> installation is using the [*Ubuntu*](../ubuntulinux/#ubuntu-linux) +> installation path. This version may be out of date because it depends on +> some binaries to be updated and published Docker is available for **RHEL** on EPEL. These instructions should work for both RHEL and CentOS. They will likely work for other binary diff --git a/docs/sources/installation/softlayer.md b/docs/sources/installation/softlayer.md index 0f55ef1e11..0b14ac567d 100644 --- a/docs/sources/installation/softlayer.md +++ b/docs/sources/installation/softlayer.md @@ -4,12 +4,11 @@ page_keywords: IBM SoftLayer, virtualization, cloud, docker, documentation, inst # IBM SoftLayer -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) ## IBM SoftLayer QuickStart diff --git a/docs/sources/installation/ubuntulinux.md b/docs/sources/installation/ubuntulinux.md index 7c642516ed..07d6072b5d 100644 --- a/docs/sources/installation/ubuntulinux.md +++ b/docs/sources/installation/ubuntulinux.md @@ -4,17 +4,15 @@ page_keywords: Docker, Docker documentation, requirements, virtualbox, vagrant, # Ubuntu -Warning +> **Warning**: +> These instructions have changed for 0.6. If you are upgrading from an +> earlier version, you will need to follow them again. -These instructions have changed for 0.6. If you are upgrading from an -earlier version, you will need to follow them again. - -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) Docker is supported on the following versions of Ubuntu: @@ -50,10 +48,9 @@ kernel. But it is safer to include them if you’re not sure. ### Installation -Warning - -These instructions have changed for 0.6. If you are upgrading from an -earlier version, you will need to follow them again. +> **Warning**: +> These instructions have changed for 0.6. If you are upgrading from an +> earlier version, you will need to follow them again. Docker is available as a Debian package, which makes installation easy. **See the** [*Mirrors*](#mirrors) **section below if you are not @@ -85,12 +82,11 @@ continue installation.* sudo apt-get update sudo apt-get install lxc-docker -Note - -There is also a simple `curl` script available to -help with this process. - - curl -s https://get.docker.io/ubuntu/ | sudo sh +> **Note**: +> +> There is also a simple `curl` script available to help with this process. +> +> curl -s https://get.docker.io/ubuntu/ | sudo sh Now verify that the installation has worked by downloading the `ubuntu` image and launching a container. @@ -124,10 +120,9 @@ To make sure AUFS is installed, run the following commands: Docker is available as a Debian package, which makes installation easy. -Warning - -Please note that these instructions have changed for 0.6. If you are -upgrading from an earlier version, you will need to follow them again. +> **Warning**: +> Please note that these instructions have changed for 0.6. If you are +> upgrading from an earlier version, you will need to follow them again. First add the Docker repository key to your local keychain. @@ -170,11 +165,10 @@ all the client commands. As of 0.9.0, you can specify that a group other than `docker` should own the Unix socket with the `-G` option. -Warning - -The *docker* group (or the group specified with `-G`) is -root-equivalent; see [*Docker Daemon Attack -Surface*](../../articles/security/#dockersecurity-daemon) details. +> **Warning**: +> The *docker* group (or the group specified with `-G`) is +> root-equivalent; see [*Docker Daemon Attack Surface*]( +> ../../articles/security/#dockersecurity-daemon) details. **Example:** @@ -286,10 +280,9 @@ The Docker daemon has to be restarted: sudo restart docker -Warning - -If you’re doing this on a laptop which connects to various networks, -make sure to choose a public DNS server. +> **Warning**: +> If you’re doing this on a laptop which connects to various networks, +> make sure to choose a public DNS server. An alternative solution involves disabling dnsmasq in NetworkManager by following these steps: @@ -306,9 +299,7 @@ NetworkManager and Docker need to be restarted afterwards: sudo restart network-manager sudo restart docker -Warning - -This might make DNS resolution slower on some networks. +> **Warning**: This might make DNS resolution slower on some networks. ## Mirrors diff --git a/docs/sources/installation/windows.md b/docs/sources/installation/windows.md index 6c37e7628c..cadecdaddb 100644 --- a/docs/sources/installation/windows.md +++ b/docs/sources/installation/windows.md @@ -10,12 +10,11 @@ that’s where Docker will run. ## Installation -Note - -Docker is still under heavy development! We don’t recommend using it in -production yet, but we’re getting closer with each release. Please see -our blog post, ["Getting to Docker -1.0"](http://blog.docker.io/2013/08/getting-to-docker-1-0/) +> **Note**: +> Docker is still under heavy development! We don’t recommend using it in +> production yet, but we’re getting closer with each release. Please see +> our blog post, [Getting to Docker 1.0]( +> http://blog.docker.io/2013/08/getting-to-docker-1-0/) 1. Install virtualbox from [https://www.virtualbox.org](https://www.virtualbox.org) - or follow @@ -26,11 +25,11 @@ our blog post, ["Getting to Docker 3. Start VirtualBox. 4. Create a new Virtual machine with the following settings: -> - Name: boot2docker -> - Type: Linux -> - Version: Linux 2.6 (64 bit) -> - Memory size: 1024 MB -> - Hard drive: Do not add a virtual hard drive +> - Name: boot2docker +> - Type: Linux +> - Version: Linux 2.6 (64 bit) +> - Memory size: 1024 MB +> - Hard drive: Do not add a virtual hard drive 5. Open the settings of the virtual machine: 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 206028188b..ac02aa5d0e 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 @@ -885,10 +885,9 @@ page_keywords: API, Docker, rcli, REST, documentation `GET /images/search` : Search for an image in the docker index. - Note - - The response keys have changed from API v1.6 to reflect the JSON - sent by the registry server to the docker daemon’s request. +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. **Example request**: 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 1ca6ff00d7..eb29699e62 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 @@ -928,10 +928,9 @@ page_keywords: API, Docker, rcli, REST, documentation `GET /images/search` : Search for an image in the docker index. - Note - - The response keys have changed from API v1.6 to reflect the JSON - sent by the registry server to the docker daemon’s request. +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. **Example request**: diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md index 7608e1f3e8..5df7d8938c 100644 --- a/docs/sources/reference/api/docker_remote_api.md +++ b/docs/sources/reference/api/docker_remote_api.md @@ -269,10 +269,9 @@ Builder (/build): intermediary buffers - Simpler, less memory usage, less disk usage and faster -Warning - -The /build improvements are not reverse-compatible. Pre 1.3 clients will -break on /build. +> **Warning**: +> The /build improvements are not reverse-compatible. Pre 1.3 clients will +> break on /build. List containers (/containers/json): 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 6350047c7e..02d13403ef 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.10.md +++ b/docs/sources/reference/api/docker_remote_api_v1.10.md @@ -912,10 +912,9 @@ page_keywords: API, Docker, rcli, REST, documentation `GET /images/search` : Search for an image in the docker index. - Note - - The response keys have changed from API v1.6 to reflect the JSON - sent by the registry server to the docker daemon’s request. +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. **Example request**: 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 626bec2b59..6e038acd82 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.11.md +++ b/docs/sources/reference/api/docker_remote_api_v1.11.md @@ -915,10 +915,9 @@ page_keywords: API, Docker, rcli, REST, documentation `GET /images/search` : Search for an image in the docker index. - Note - - The response keys have changed from API v1.6 to reflect the JSON - sent by the registry server to the docker daemon’s request. +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. **Example request**: 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 aaa777292b..aaa8dc194b 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.9.md +++ b/docs/sources/reference/api/docker_remote_api_v1.9.md @@ -928,10 +928,9 @@ page_keywords: API, Docker, rcli, REST, documentation `GET /images/search` : Search for an image in the docker index. - Note - - The response keys have changed from API v1.6 to reflect the JSON - sent by the registry server to the docker daemon’s request. +> **Note**: +> The response keys have changed from API v1.6 to reflect the JSON +> sent by the registry server to the docker daemon’s request. **Example request**: diff --git a/docs/sources/reference/api/registry_api.md b/docs/sources/reference/api/registry_api.md index 8ea6da28f1..09035515f5 100644 --- a/docs/sources/reference/api/registry_api.md +++ b/docs/sources/reference/api/registry_api.md @@ -48,19 +48,19 @@ grasp the context, here are some examples of registries: control. It can optionally delegate additional authorization to the Index, but it is not mandatory. -Note +> **Note**: +> Mirror registries and private registries which do not use the Index +> don’t even need to run the registry code. They can be implemented by any +> kind of transport implementing HTTP GET and PUT. Read-only registries +> can be powered by a simple static HTTP server. -Mirror registries and private registries which do not use the Index -don’t even need to run the registry code. They can be implemented by any -kind of transport implementing HTTP GET and PUT. Read-only registries -can be powered by a simple static HTTP server. - -Note - -The latter implies that while HTTP is the protocol of choice for a registry, multiple schemes are possible (and in some cases, trivial): -: - HTTP with GET (and PUT for read-write registries); - - local mount point; - - remote docker addressed through SSH. +> **Note**: +> The latter implies that while HTTP is the protocol of choice for a registry, +> multiple schemes are possible (and in some cases, trivial): +> +> - HTTP with GET (and PUT for read-write registries); +> - local mount point; +> - remote docker addressed through SSH. The latter would only require two new commands in docker, e.g. `registryget` and `registryput`, diff --git a/docs/sources/reference/api/registry_index_spec.md b/docs/sources/reference/api/registry_index_spec.md index 84a40a7993..53006cf0b5 100644 --- a/docs/sources/reference/api/registry_index_spec.md +++ b/docs/sources/reference/api/registry_index_spec.md @@ -183,10 +183,9 @@ and for an active account. : (for each image id returned in the registry, fetch /json + /layer) -Note - -If someone makes a second request, then we will always give a new token, -never reuse tokens. +> **Note**: +> If someone makes a second request, then we will always give a new token, +> never reuse tokens. ### Push @@ -333,11 +332,10 @@ nice clean way to do that. Here is the workflow. 6. docker contacts the index to let it know it was removed from the registry, the index removes all records from the database. -Note - -The Docker client should present an "Are you sure?" prompt to confirm -the deletion before starting the process. Once it starts it can’t be -undone. +> **Note**: +> The Docker client should present an "Are you sure?" prompt to confirm +> the deletion before starting the process. Once it starts it can’t be +> undone. #### API (deleting repository foo/bar): @@ -486,10 +484,9 @@ Errors: HTTP 400 (we should create error codes for possible errors) - invalid json - missing field - wrong format (username, password, email, etc) - forbidden name - name already exists -Note - -A user account will be valid only if the email has been validated (a -validation link is sent to the email address). +> **Note**: +> A user account will be valid only if the email has been validated (a +> validation link is sent to the email address). ### Update a user (Index) @@ -498,10 +495,9 @@ PUT /v1/users/\ **Body**: : {"password": "toto"} -Note - -We can also update email address, if they do, they will need to reverify -their new email address. +> **Note**: +> We can also update email address, if they do, they will need to reverify +> their new email address. ### Login (Index) diff --git a/docs/sources/reference/builder.md b/docs/sources/reference/builder.md index c28cd883cd..89bf352cbc 100644 --- a/docs/sources/reference/builder.md +++ b/docs/sources/reference/builder.md @@ -195,12 +195,10 @@ combination with `CMD`. See If the user specifies arguments to `docker run` then they will override the default specified in CMD. -Note - -Don’t confuse `RUN` with `CMD`. -`RUN` actually runs a command and commits the -result; `CMD` does not execute anything at build -time, but specifies the intended command for the image. +> **Note**: +> Don’t confuse `RUN` with `CMD`. `RUN` actually runs a command and commits +> the result; `CMD` does not execute anything at build time, but specifies +> the intended command for the image. ## `EXPOSE` @@ -228,12 +226,11 @@ persist when a container is run from the resulting image. You can view the values using `docker inspect`, and change them using `docker run --env =`. -Note - -One example where this can cause unexpected consequenses, is setting -`ENV DEBIAN_FRONTEND noninteractive`. Which will -persist when the container is run interactively; for example: -`docker run -t -i image bash` +> **Note**: +> One example where this can cause unexpected consequenses, is setting +> `ENV DEBIAN_FRONTEND noninteractive`. Which will +> persist when the container is run interactively; for example: +> `docker run -t -i image bash` ## `ADD` @@ -252,18 +249,16 @@ will be copied inside the destination container. All new files and directories are created with mode 0755, uid and gid 0. -Note +> **Note**: +> If you build using STDIN (`docker build - < somefile`), there is no +> build context, so the Dockerfile can only contain an URL based ADD +> statement. -if you build using STDIN (`docker build - < somefile`), there is no -build context, so the Dockerfile can only contain an URL based ADD -statement. - -Note - -if your URL files are protected using authentication, you will need to -use an `RUN wget` , `RUN curl` -or other tool from within the container as ADD does not support -authentication. +> **Note**: +> If your URL files are protected using authentication, you will need to +> use an `RUN wget` , `RUN curl` +> or other tool from within the container as ADD does not support +> authentication. The copy obeys the following rules: @@ -450,13 +445,9 @@ For example you might add something like this: ONBUILD RUN /usr/local/bin/python-build --dir /app/src [...] -Warning +> **Warning**: Chaining ONBUILD instructions using ONBUILD ONBUILD isn’t allowed. -Chaining ONBUILD instructions using ONBUILD ONBUILD isn’t allowed. - -Warning - -ONBUILD may not trigger FROM or MAINTAINER instructions. +> **Warning**: ONBUILD may not trigger FROM or MAINTAINER instructions. ## Dockerfile Examples diff --git a/docs/sources/use/basics.md b/docs/sources/use/basics.md index 8f3d11622f..e283a9dec8 100644 --- a/docs/sources/use/basics.md +++ b/docs/sources/use/basics.md @@ -30,14 +30,12 @@ This will find the `ubuntu` image by name in the download it from the top-level Central Repository to a local image cache. -Note - -When the image has successfully downloaded, you will see a 12 character -hash `539c0211cd76: Download complete` which is the -short form of the image ID. These short image IDs are the first 12 -characters of the full image ID - which can be found using -`docker inspect` or -`docker images --no-trunc=true` +> **Note**: +> When the image has successfully downloaded, you will see a 12 character +> hash `539c0211cd76: Download complete` which is the +> short form of the image ID. These short image IDs are the first 12 +> characters of the full image ID - which can be found using +> `docker inspect` or `docker images --no-trunc=true` **If you’re using OS X** then you shouldn’t use `sudo`. @@ -52,14 +50,13 @@ characters of the full image ID - which can be found using ## Bind Docker to another host/port or a Unix socket -Warning - -Changing the default `docker` daemon binding to a -TCP port or Unix *docker* user group will increase your security risks -by allowing non-root users to gain *root* access on the host. Make sure -you control access to `docker`. If you are binding -to a TCP port, anyone with access to that port has full Docker access; -so it is not advisable on an open network. +> **Warning**: +> Changing the default `docker` daemon binding to a +> TCP port or Unix *docker* user group will increase your security risks +> by allowing non-root users to gain *root* access on the host. Make sure +> you control access to `docker`. If you are binding +> to a TCP port, anyone with access to that port has full Docker access; +> so it is not advisable on an open network. With `-H` it is possible to make the Docker daemon to listen on a specific IP and port. By default, it will listen on diff --git a/docs/sources/use/chef.md b/docs/sources/use/chef.md index dfbf8d382e..87e3215ced 100644 --- a/docs/sources/use/chef.md +++ b/docs/sources/use/chef.md @@ -4,12 +4,11 @@ page_keywords: chef, installation, usage, docker, documentation # Using Chef -Note - -Please note this is a community contributed installation path. The only -‘official’ installation is using the -[*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation -path. This version may sometimes be out of date. +> **Note**: +> Please note this is a community contributed installation path. The only +> ‘official’ installation is using the +> [*Ubuntu*](../../installation/ubuntulinux/#ubuntu-linux) installation +> path. This version may sometimes be out of date. ## Requirements diff --git a/docs/sources/use/working_with_links_names.md b/docs/sources/use/working_with_links_names.md index 7813b0fd31..67ca8004f1 100644 --- a/docs/sources/use/working_with_links_names.md +++ b/docs/sources/use/working_with_links_names.md @@ -102,11 +102,10 @@ Accessing the network information along with the environment of the child container allows us to easily connect to the Redis service on the specific IP and port in the environment. -Note - -These Environment variables are only set for the first process in the -container. Similarly, some daemons (such as `sshd`) -will scrub them when spawning shells for connection. +> **Note**: +> These Environment variables are only set for the first process in the +> container. Similarly, some daemons (such as `sshd`) +> will scrub them when spawning shells for connection. You can work around this by storing the initial `env` in a file, or looking at `/proc/1/environ`.