Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Go to file
Michael Crosby 8ac075b846 Merge pull request #10036 from HuKeping/docs-next
docs: update docker inspect part of docs
2015-01-13 16:43:42 -08:00
api Remove error return type from createRouter and ServeRequest 2015-01-13 22:43:31 +01:00
builder Merge pull request #9973 from duglin/Issue9880 2015-01-13 11:17:34 -08:00
builtins Don't hard code true for auth job 2014-10-30 19:41:55 -04:00
contrib Delete man pages of installed packages in mkimage-arch.sh 2015-01-13 18:10:50 +01:00
daemon Merge pull request #10079 from tonistiigi/fix-attach-stdin 2015-01-13 16:40:42 -08:00
docker rename a existing container 2015-01-13 03:27:17 +00:00
dockerinit pkg/reexec: move reexec code to a new package 2014-10-30 14:48:30 +02:00
dockerversion
docs Merge pull request #10036 from HuKeping/docs-next 2015-01-13 16:43:42 -08:00
engine Remove unused Engine.Logf 2014-12-02 10:47:57 -08:00
events events filtering 2014-11-20 19:46:48 +00:00
graph Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
image Adds Docker Image v1 Spec Documention 2015-01-12 10:37:46 -08:00
integration Remove error return type from createRouter and ServeRequest 2015-01-13 22:43:31 +01:00
integration-cli Merge pull request #10079 from tonistiigi/fix-attach-stdin 2015-01-13 16:40:42 -08:00
links Move per-container forward rules to DOCKER chain 2014-12-21 12:57:32 +10:00
nat add ability to publish range of ports 2015-01-02 23:21:26 +00:00
opts Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
pkg correct the flag comments 2015-01-13 15:40:24 +08:00
project Merge pull request #10055 from icecrime/upgrade_libcontainer 2015-01-12 20:44:25 -08:00
registry registry: fix minor type 2015-01-09 09:06:27 +08:00
runconfig Merge pull request #9603 from hqhq/hq_add_memory_swap 2015-01-06 10:09:21 -08:00
trust Remove obsolete comments 2014-11-17 23:27:03 +09:00
utils Fix docker run/exec/create not printing error messages 2015-01-13 09:23:13 -05:00
vendor Upgrade libcontainer to 1d3b2589d734dc94a1719a3af4 2015-01-12 18:12:59 -08:00
volumes Have .dockerignore support Dockerfile/.dockerignore 2015-01-06 10:57:48 -08:00
.dockerignore
.drone.yml Add docker-py tests to drone. 2015-01-05 15:00:32 -08:00
.gitignore Update docs release script so we can have autodeploys 2015-01-12 09:56:43 -08:00
.mailmap Update AUTHORS file 2014-11-16 23:41:25 -08:00
AUTHORS Update AUTHORS file 2014-11-16 23:41:25 -08:00
CHANGELOG.md Bump to version 1.4.1 2014-12-15 15:57:00 -08:00
CONTRIBUTING.md Remove DCO small patch exception 2014-12-17 10:02:36 +10:00
Dockerfile Switch docker-py clone to use an explicit commit for natural cache-busting 2015-01-13 12:34:55 -07:00
LICENSE Update License year to range 2013-2015 2015-01-04 16:59:34 -08:00
MAINTAINERS add @tianon as maintainer of .dockerignore 2014-06-26 22:49:08 +00:00
Makefile Update docs release script so we can have autodeploys 2015-01-12 09:56:43 -08:00
NOTICE
README.md Merge pull request #9992 from iKevinY/readme-italics 2015-01-12 11:50:04 -08:00
VERSION Change version to 1.4.1-dev 2014-12-16 12:26:01 -08:00
hack Move 'hack' to the less confusing 'project' 2014-11-09 21:50:28 +00: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 they can run anywhere, from your laptop to the largest EC2 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 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 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 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 Jenkins Build Status

Want to hack on Docker? Awesome! We have instructions to help you get started. If you'd like to contribute to the documentation, please take a look at this README.md.

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.

Want to run Docker from a master build? You can download master builds at master.dockerproject.com. 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.com.

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 http://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.

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.