Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Go to file
Bert Goethals 762ffda95d makes the -s --size option documentation clearer 2014-11-04 17:49:39 +01:00
api Merge pull request #8871 from tonistiigi/start-wait-hijack 2014-11-04 08:46:56 -08:00
builder Merge pull request #8468 from laktek/master 2014-10-31 14:43:21 -07:00
builtins Don't hard code true for auth job 2014-10-30 19:41:55 -04:00
contrib Merge pull request #8198 from jfrazelle/add-jessie-to-various-maintainers 2014-10-28 19:35:28 -07:00
daemon Merge pull request #8877 from erikh/proxy_error_check 2014-11-04 11:40:02 -05:00
docker Fix docker exec command help messages 2014-10-31 09:36:07 +08:00
dockerinit pkg/reexec: move reexec code to a new package 2014-10-30 14:48:30 +02:00
dockerversion Move even more stuff into dockerversion 2014-02-11 17:26:54 -07:00
docs makes the -s --size option documentation clearer 2014-11-04 17:49:39 +01:00
engine fix for iptables cleanup 8307 2014-10-29 10:59:20 -07:00
events Revert "Fix line delimited JSON response" 2014-10-09 13:46:21 -07:00
graph Merge pull request #8799 from jlhawn/remove_jsondata_arg 2014-11-03 20:55:40 -05:00
hack Update logrus to v0.6.0 so we can use ParseLevel() for PR #8335 2014-11-03 11:57:30 -08:00
image Remove `jsonData` argument from `image.StoreImage` 2014-11-03 17:39:21 -08:00
integration Merge pull request #8799 from jlhawn/remove_jsondata_arg 2014-11-03 20:55:40 -05:00
integration-cli Merge pull request #8390 from MalteJ/set-macaddress 2014-11-04 07:54:59 -08:00
links adding support for port ranges on --expose 2014-10-31 23:06:30 +00:00
nat adding support for port ranges on --expose 2014-10-31 23:06:30 +00:00
opts Allow extra lines in /etc/hosts 2014-09-16 23:38:23 +00:00
pkg Merge pull request #8813 from jlhawn/aufs_exclude_on_tar_layer 2014-11-04 11:38:12 -05:00
registry Fix login command 2014-10-30 19:44:44 -04:00
runconfig enhancing set-macaddress docu 2014-11-03 11:43:27 +01:00
trust Mass gofmt 2014-10-24 15:11:48 -07:00
utils change util.CopyDirectory to archive.CopyWithTar 2014-11-01 12:23:08 -04:00
vendor Update logrus to v0.6.0 so we can use ParseLevel() for PR #8335 2014-11-03 11:57:30 -08:00
volumes Mass gofmt 2014-10-24 15:11:48 -07:00
.dockerignore Add .dockerignore support 2014-06-26 22:49:08 +00:00
.drone.yml Drone Config: Disable integration-cli/docker_cli_exec_test as it breaks. 2014-09-19 15:40:48 -07:00
.gitignore Revert "Use code generation to set IAMSTATIC instead of -X" 2014-10-28 16:25:50 -07:00
.mailmap Fix my email entry so that my current email is first and the old commit email second. 2014-08-12 13:24:42 -07:00
.travis.yml Update Travis to also run the test suite 2014-09-04 17:20:02 -06:00
AUTHORS Updated AUTHORS file 2014-08-12 16:19:10 -07:00
CHANGELOG.md Typo in 1.3.1 change log 2014-10-31 08:31:20 +01:00
CONTRIBUTING.md Replace fast with quickly 2014-10-23 11:06:36 -07:00
Dockerfile DOCKER_VERSION and docker-version havn't been implemented. 2014-10-21 16:04:11 +10:00
LICENSE Fix boilerplate text in Apache license 2014-03-12 23:39:36 -07:00
MAINTAINERS add @tianon as maintainer of .dockerignore 2014-06-26 22:49:08 +00:00
Makefile Add --dryrun to allow testing to the docs-release site, and then fix the double dollar mistake 2014-10-24 11:36:07 +10:00
NOTICE Fixes 3497 2014-01-13 17:12:53 -08:00
README.md Add GoDoc and Travis build link/images to README 2014-08-19 01:08:47 +02:00
VERSION Change version to 1.3.1-dev 2014-10-30 19:45:07 -04:00

README.md

Docker: the Linux container engine

Docker is an open source project to pack, ship and run any application as a lightweight container

Docker containers are both hardware-agnostic and platform-agnostic. This means that they can run anywhere, from your laptop to the largest EC2 compute instance and everything in between - and they don't require that you use a particular language, framework or packaging system. That makes them great building blocks for deploying and scaling web apps, databases and backend services without depending on a particular stack or provider.

Docker is an open-source implementation of the deployment engine which powers dotCloud, a popular Platform-as-a-Service. It benefits directly from the experience accumulated over several years of large-scale operation and support of hundreds of thousands of applications and databases.

Docker L

Security Disclosure

Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to security@docker.com and not by creating a github issue.

Better than VMs

A common method for distributing applications and sandboxing their execution is to use virtual machines, or VMs. Typical VM formats are VMWare's vmdk, Oracle Virtualbox's vdi, and Amazon EC2's ami. In theory these formats should allow every developer to automatically package their application into a "machine" for easy distribution and deployment. In practice, that almost never happens, for a few reasons:

  • Size: VMs are very large which makes them impractical to store and transfer.
  • Performance: running VMs consumes significant CPU and memory, which makes them impractical in many scenarios, for example local development of multi-tier applications, and large-scale deployment of cpu and memory-intensive applications on large numbers of machines.
  • Portability: competing VM environments don't play well with each other. Although conversion tools do exist, they are limited and add even more overhead.
  • Hardware-centric: VMs were designed with machine operators in mind, not software developers. As a result, they offer very limited tooling for what developers need most: building, testing and running their software. For example, VMs offer no facilities for application versioning, monitoring, configuration, logging or service discovery.

By contrast, Docker relies on a different sandboxing method known as containerization. Unlike traditional virtualization, containerization takes place at the kernel level. Most modern operating system kernels now support the primitives necessary for containerization, including Linux with openvz, vserver and more recently lxc, Solaris with zones and FreeBSD with Jails.

Docker builds on top of these low-level primitives to offer developers a portable format and runtime environment that solves all 4 problems. Docker containers are small (and their transfer can be optimized with layers), they have basically zero memory and cpu overhead, they are completely portable and are designed from the ground up with an application-centric design.

The best part: because Docker operates at the OS level, it can still be run inside a VM!

Plays well with others

Docker does not require that you buy into a particular programming language, framework, packaging system or configuration language.

Is your application a Unix process? Does it use files, tcp connections, environment variables, standard Unix streams and command-line arguments as inputs and outputs? Then Docker can run it.

Can your application's build be expressed as a sequence of such commands? Then Docker can build it.

Escape dependency hell

A common problem for developers is the difficulty of managing all their application's dependencies in a simple and automated way.

This is usually difficult for several reasons:

  • Cross-platform dependencies. Modern applications often depend on a combination of system libraries and binaries, language-specific packages, framework-specific modules, internal components developed for another project, etc. These dependencies live in different "worlds" and require different tools - these tools typically don't work well with each other, requiring awkward custom integrations.

  • Conflicting dependencies. Different applications may depend on different versions of the same dependency. Packaging tools handle these situations with various degrees of ease - but they all handle them in different and incompatible ways, which again forces the developer to do extra work.

  • Custom dependencies. A developer may need to prepare a custom version of their application's dependency. Some packaging systems can handle custom versions of a dependency, others can't - and all of them handle it differently.

Docker solves dependency hell by giving the developer a simple way to express all their application's dependencies in one place, and streamline the process of assembling them. If this makes you think of XKCD 927, don't worry. Docker doesn't replace your favorite packaging systems. It simply orchestrates their use in a simple and repeatable way. How does it do that? With layers.

Docker defines a build as running a sequence of Unix commands, one after the other, in the same container. Build commands modify the contents of the container (usually by installing new files on the filesystem), the next command modifies it some more, etc. Since each build command inherits the result of the previous commands, the order in which the commands are executed expresses dependencies.

Here's a typical Docker build process:

FROM ubuntu:12.04
RUN apt-get update && apt-get install -y python python-pip curl
RUN curl -sSL https://github.com/shykes/helloflask/archive/master.tar.gz | tar -xzv
RUN cd helloflask-master && pip install -r requirements.txt

Note that Docker doesn't care how dependencies are built - as long as they can be built by running a Unix command in a container.

Getting started

Docker can be installed on your local machine as well as servers - both bare metal and virtualized. It is available as a binary on most modern Linux systems, or as a VM on Windows, Mac and other systems.

We also offer an interactive tutorial for quickly learning the basics of using Docker.

For up-to-date install instructions, see the Docs.

Usage examples

Docker can be used to run short-lived commands, long-running daemons (app servers, databases etc.), interactive shell sessions, etc.

You can find a list of real-world examples in the documentation.

Under the hood

Under the hood, Docker is built on the following components:

Contributing to Docker

GoDoc Travis

Want to hack on Docker? Awesome! There are instructions to get you started here.

They are probably not perfect, please let us know if anything feels wrong or incomplete.

Brought to you courtesy of our legal counsel. For more context, please see the Notice document.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see http://www.bis.doc.gov

Licensing

Docker is licensed under the Apache License, Version 2.0. See LICENSE for full license text.