Docker - the open-source application container engine
Go Shell Other
Latest commit 297745b Jul 27, 2016 @crosbymichael crosbymichael committed on GitHub Merge pull request #24760 from anusha-ragunathan/plugin-events
Make daemon events listen for plugin lifecycle events.
Failed to load latest commit information.
.github pull-request template: ask for changelog description Apr 26, 2016
api Merge pull request #25047 from aaronlehmann/unsafe-flag-updates Jul 26, 2016
builder Move directive out of globals Jul 26, 2016
cli Add a script to generate man pages from cobra commands. Jul 19, 2016
cliconfig Use docker-credential-helpers client to talk with native creds stores. Jun 4, 2016
cmd Make daemon events listen for plugin lifecycle events. Jul 26, 2016
container Treat HEALTHCHECK NONE the same as not setting a healthcheck Jul 25, 2016
contrib Remove the Require on the socket for the rpm Jul 26, 2016
daemon Merge pull request #24760 from anusha-ragunathan/plugin-events Jul 27, 2016
distribution swarm/controller: allow cancellation to propagate Jul 25, 2016
dockerversion Pass upstream client's user agent through to registry on operations b… Mar 21, 2016
docs Merge pull request #24760 from anusha-ragunathan/plugin-events Jul 27, 2016
errors Fix authorization issue - when request is denied return forbbiden exi… May 2, 2016
experimental Add a bundlefile example in the documentation Jul 25, 2016
hack Vendoring libnetwork to fix #25109 Jul 27, 2016
image Fix calculation of relative path for symlink on docker save Jul 25, 2016
integration-cli Merge pull request #24760 from anusha-ragunathan/plugin-events Jul 27, 2016
layer fix some typos Jun 21, 2016
libcontainerd Fix daemon panic on restoring containers Jul 26, 2016
man Require listen address and advertise address to be an IP address or a… Jul 24, 2016
migrate/v1 Safer file io for configuration files Apr 21, 2016
oci Get the Docker Engine to build clean on Solaris May 23, 2016
opts Fix opts tests after default port fix Jun 21, 2016
pkg Modify func name from TestChtimes to TestChtimesLinux Jul 27, 2016
plugin Make daemon events listen for plugin lifecycle events. Jul 26, 2016
profiles Move mlock back into the default ungated seccomp profile Jun 15, 2016
project Update Golang requirements in PACKAGERS.md Jun 11, 2016
reference reference: Do not drop the underlying error message Jul 1, 2016
registry Improve flag help consistency, and update docs Jul 16, 2016
restartmanager fix some typos Jun 21, 2016
runconfig Merge pull request #24705 from thaJeztah/update-flag-descriptions Jul 18, 2016
utils Replace execdrivers with containerd implementation Mar 18, 2016
vendor/src Vendoring libnetwork to fix #25109 Jul 27, 2016
volume fix typos Jul 23, 2016
.dockerignore mount .go-pkg-cache for DOCKER_INCREMENTAL_BINARY Jul 20, 2016
.gitignore mount .go-pkg-cache for DOCKER_INCREMENTAL_BINARY Jul 20, 2016
.mailmap Fix double entry in authors Jun 3, 2016
AUTHORS Fix double entry in authors Jun 3, 2016
CHANGELOG.md Fix spelling in comments, strings and documentation Jul 3, 2016
CONTRIBUTING.md fix typos Jul 23, 2016
Dockerfile Merge pull request #24648 from mlaventure/fix-kill-test Jul 19, 2016
Dockerfile.aarch64 Harmonize containerd commit used by all Dockerfile Jul 21, 2016
Dockerfile.armhf Harmonize containerd commit used by all Dockerfile Jul 21, 2016
Dockerfile.gccgo Harmonize containerd commit used by all Dockerfile Jul 21, 2016
Dockerfile.ppc64le Harmonize containerd commit used by all Dockerfile Jul 21, 2016
Dockerfile.s390x Merge pull request #24904 from mlaventure/update-dockerfile-container… Jul 21, 2016
Dockerfile.simple Harmonize containerd commit used by all Dockerfile Jul 21, 2016
Dockerfile.windows bump Go to 1.6.3 Jul 18, 2016
LICENSE Update LICENSE date Dec 31, 2015
MAINTAINERS Add new maintainers Jul 15, 2016
Makefile mount .go-pkg-cache for DOCKER_INCREMENTAL_BINARY Jul 20, 2016
NOTICE Update LICENSE date Dec 31, 2015
README.md fix some nits and typo Jul 3, 2016
ROADMAP.md Update ROADMAP.md Feb 18, 2016
VENDORING.md Create standard vendor policies. Jan 7, 2016
VERSION Bump version to v1.12.0-dev Apr 14, 2016

README.md

Docker: the container engine Release

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 they can run anywhere, from your laptop to the largest cloud compute instance and everything in between - and they don't require you to 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 began as an open-source implementation of the deployment engine which powered 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 logo

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 four 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.

Perhaps best of all, because Docker operates at the OS level, it can still be run inside a VM!

Plays well with others

Docker does not require you to 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 the problem of dependency hell by giving the developer a simple way to express all their application's dependencies in one place, while streamlining 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 either on your computer for building applications or on servers for running them. To get started, check out the installation instructions in the documentation.

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

Master (Linux) Experimental (Linux) Windows FreeBSD
Jenkins Build Status Jenkins Build Status Build Status Build Status

Want to hack on Docker? Awesome! We have instructions to help you get started contributing code or documentation.

These instructions are probably not perfect, please let us know if anything feels wrong or incomplete. Better yet, submit a PR and improve them yourself.

Getting the development builds

Want to run Docker from a master build? You can download master builds at master.dockerproject.org. They are updated with each commit merged into the master branch.

Don't know how to use that super cool new feature in the master build? Check out the master docs at docs.master.dockerproject.org.

How the project is run

Docker is a very, very active project. If you want to learn more about how it is run, or want to get more involved, the best place to start is the project directory.

We are always open to suggestions on process improvements, and are always looking for more maintainers.

Talking to other Docker users and contributors

Internet Relay Chat (IRC)

IRC is a direct line to our most knowledgeable Docker users; we have both the #docker and #docker-dev group on irc.freenode.net. IRC is a rich chat protocol but it can overwhelm new users. You can search our chat archives.

Read our IRC quickstart guide for an easy way to get started.
Docker Community Forums The Docker Engine group is for users of the Docker Engine project.
Google Groups The docker-dev group is for contributors and other people contributing to the Docker project. You can join this group without a Google account by sending an email to docker-dev+subscribe@googlegroups.com. You'll receive a join-request message; simply reply to the message to confirm your subscription.
Twitter You can follow Docker's Twitter feed to get updates on our products. You can also tweet us questions or just share blogs or stories.
Stack Overflow Stack Overflow has over 7000 Docker questions listed. We regularly monitor Docker questions and so do many other knowledgeable Docker users.

Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

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 https://www.bis.doc.gov

Licensing

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

Other Docker Related Projects

There are a number of projects under development that are based on Docker's core technology. These projects expand the tooling built around the Docker platform to broaden its application and utility.

  • Docker Registry: Registry server for Docker (hosting/delivery of repositories and images)
  • Docker Machine: Machine management for a container-centric world
  • Docker Swarm: A Docker-native clustering system
  • Docker Compose (formerly Fig): Define and run multi-container apps
  • Kitematic: The easiest way to use Docker on Mac and Windows

If you know of another project underway that should be listed here, please help us keep this list up-to-date by submitting a PR.

Awesome-Docker

You can find more projects, tools and articles related to Docker on the awesome-docker list. Add your project there.