FreeBSD port of docker, take a look at PORTING-FREEBSD.md in freebsd-compat branch
Pull request Compare This branch is 18837 commits behind moby:master.
Latest commit 2cd058c Jul 29, 2015
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api Merge pull request moby#14785 from brahmaroutu/lint_api_server Jul 29, 2015
builder Merge pull request moby#14759 from vdemeester/pkg-golint Jul 27, 2015
cli cli: new daemon command and new cli package Jul 23, 2015
cliconfig ps --format: Add config.js doc, fix gofmt, add integration tests Jul 22, 2015
contrib Mark engine AA policy as complain-only Jul 28, 2015
daemon Merge pull request moby#15099 from ewindisch/apparmor-restore-en Jul 29, 2015
docker api/server fix golint errors/warnings. Jul 28, 2015
dockerinit pkg/reexec: move reexec code to a new package Nov 11, 2014
docs Merge pull request moby#15099 from ewindisch/apparmor-restore-en Jul 29, 2015
experimental Put the network UI and overlay docs in separate files Jul 22, 2015
graph Replace GenerateRandomID with GenerateNonCryptoID Jul 29, 2015
hack Merge pull request moby#14785 from brahmaroutu/lint_api_server Jul 29, 2015
image /image - fix lint errors/warnings Jul 27, 2015
integration-cli Merge pull request moby#15099 from ewindisch/apparmor-restore-en Jul 29, 2015
links Remove panic in nat package on invalid hostport Jul 17, 2015
man Merge pull request moby#14971 from moxiegirl/man-page-carry-14637 Jul 27, 2015
opts Remove unused functions Jul 25, 2015
pkg Replace GenerateRandomID with GenerateNonCryptoID Jul 29, 2015
project Merge pull request moby#14720 from icecrime/14662_document_branches_tags Jul 25, 2015
registry Use notary library for trusted image fetch and signing Jul 24, 2015
runconfig Lint fixes on runconfig Jul 27, 2015
trust Show exact file being parsed on error. Jul 24, 2015
utils Replace GenerateRandomID with GenerateNonCryptoID Jul 29, 2015
vendor/src Merge pull request moby#14838 from Microsoft/10662-ansirewrite Jul 28, 2015
volume lint fixes for volume/* Jul 28, 2015
.dockerignore Add .dockerignore support Jun 26, 2014
.gitignore Fix Windows CI fail due to GH13866 and patch up tests Jul 9, 2015
.mailmap update authors and mailmap Jun 7, 2015
AUTHORS update authors and mailmap Jun 7, 2015
CHANGELOG.md Bump to version 1.7.1 Jul 14, 2015
CONTRIBUTING.md Adding Go coding style guidelines Jul 21, 2015
Dockerfile Add integration cli trust tests Jul 24, 2015
Dockerfile.simple Fail explicitly if curl is missing in contrib/download-frozen-image.sh Mar 18, 2015
LICENSE Link to HTTPS URLs Apr 11, 2015
MAINTAINERS Remove reviewing process from MAINTAINERS Jul 15, 2015
Makefile Add golint to the development toolbox Jul 21, 2015
NOTICE Link to HTTPS URLs Apr 11, 2015
README.md Remove duplicated period in link Jul 15, 2015
ROADMAP.md Impose moratorium on remote registry access Jul 24, 2015
VERSION Bump version to 1.8.0-dev. Jul 14, 2015

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 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 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.
Google Groups There are two groups. Docker-user is for people using Docker containers. The docker-dev group is for contributors and other people contributing to the Docker project.
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 7000K 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.