The toolkit to pack, ship, store, and deliver container content
Find a file
Olivier Gambier 2c803d6fd0 Merge pull request #1587 from aaronlehmann/build-docs
docs: No need to change GOPATH to use vendored code
2016-03-31 14:04:57 -07:00
cmd Removes ceph rados driver in favor of Swift API gateway support 2016-03-10 16:49:08 -08:00
configuration Enable URLs returned from the registry to be configured as relative. 2016-03-23 15:14:32 -07:00
context type judgment in context 2016-03-30 17:35:48 +08:00
contrib Removes ceph rados driver in favor of Swift API gateway support 2016-03-10 16:49:08 -08:00
digest Typo fixes in comments 2016-02-10 16:26:29 -08:00
docs Merge pull request #1587 from aaronlehmann/build-docs 2016-03-31 14:04:57 -07:00
Godeps Fix GCS 2016-03-22 10:50:52 -07:00
health Add headers parameter for HTTP checker 2015-08-20 15:11:16 -07:00
manifest Add os.version and os.features to platform spec 2016-03-17 16:54:21 -07:00
notifications Merge pull request #1522 from RichardScothern/tag-events 2016-03-23 16:41:29 -07:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference Merge pull request #1455 from RichardScothern/grammar-correct 2016-02-11 10:40:22 -08:00
registry Merge pull request #1578 from majewsky/do-not-swallow-error 2016-03-30 17:46:27 -07:00
testutil Implements garbage collection subcommand 2016-02-29 14:15:21 -08:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor Fix GCS 2016-03-22 10:50:52 -07:00
version Rev base version to 2.4.0 2016-03-28 13:54:28 -07:00
.gitignore Improve context package 2015-04-01 15:40:21 -07:00
.mailmap Move to vendor 2016-03-22 10:45:49 -07:00
AUTHORS Update AUTHORS 2016-03-24 13:03:46 -07:00
blobs.go Adds new storagedriver.FileWriter interface 2016-03-08 16:37:44 -08:00
circle.yml Make dep-validate more selective 2016-03-23 12:10:40 -07:00
CONTRIBUTING.md Removes ceph rados driver in favor of Swift API gateway support 2016-03-10 16:49:08 -08:00
coverpkg.sh Fix codecov following vendor 2016-03-24 10:30:14 -07:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile Move to vendor 2016-03-22 10:45:49 -07:00
errors.go Defined ErrAccessDenied error 2016-02-22 21:12:59 +01:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Update maintainers and authors 2016-02-04 10:40:51 -08:00
Makefile Fix GCS 2016-03-22 10:50:52 -07:00
manifests.go Fix two misspellings in source code comments 2016-03-08 15:13:24 -08:00
README.md Replace a strange comma with a space. 2016-03-23 17:35:30 +08:00
registry.go Update documentation and examples in notifications.md 2016-03-23 15:51:32 -07:00
ROADMAP.md Update distribution roadmap. 2015-10-27 17:20:49 -07:00
tags.go Implementation of the Manifest Service API refactor. 2015-12-17 17:09:14 -08:00

Distribution

The Docker toolset to pack, ship, store, and deliver content.

This repository's main product is the Docker Registry 2.0 implementation for storing and distributing Docker images. It supersedes the docker/docker-registry project with a new API design, focused around security and performance.

Circle CI GoDoc

This repository contains the following components:

Component Description
registry An implementation of the Docker Registry HTTP API V2 for use with docker 1.6+.
libraries A rich set of libraries for interacting with distribution components. Please see godoc for details. Note: These libraries are unstable.
specifications Distribution related specifications are available in docs/spec
documentation Docker's full documentation set is available at docs.docker.com. This repository contains the subset related just to the registry.

How does this integrate with Docker engine?

This project should provide an implementation to a V2 API for use in the Docker core project. The API should be embeddable and simplify the process of securely pulling and pushing content from docker daemons.

What are the long term goals of the Distribution project?

The Distribution project has the further long term goal of providing a secure tool chain for distributing content. The specifications, APIs and tools should be as useful with Docker as they are without.

Our goal is to design a professional grade and extensible content distribution system that allow users to:

  • Enjoy an efficient, secured and reliable way to store, manage, package and exchange content
  • Hack/roll their own on top of healthy open-source components
  • Implement their own home made solution through good specs, and solid extensions mechanism.

More about Registry 2.0

The new registry implementation provides the following benefits:

  • faster push and pull
  • new, more efficient implementation
  • simplified deployment
  • pluggable storage backend
  • webhook notifications

For information on upcoming functionality, please see ROADMAP.md.

Who needs to deploy a registry?

By default, Docker users pull images from Docker's public registry instance. Installing Docker gives users this ability. Users can also push images to a repository on Docker's public registry, if they have a Docker Hub account.

For some users and even companies, this default behavior is sufficient. For others, it is not.

For example, users with their own software products may want to maintain a registry for private, company images. Also, you may wish to deploy your own image repository for images used to test or in continuous integration. For these use cases and others, deploying your own registry instance may be the better choice.

Migration to Registry 2.0

For those who have previously deployed their own registry based on the Registry 1.0 implementation and wish to deploy a Registry 2.0 while retaining images, data migration is required. A tool to assist with migration efforts has been created. For more information see [docker/migrator] (https://github.com/docker/migrator).

Contribute

Please see CONTRIBUTING.md for details on how to contribute issues, fixes, and patches to this project. If you are contributing code, see the instructions for building a development environment.

Support

If any issues are encountered while using the Distribution project, several avenues are available for support:

IRC #docker-distribution on FreeNode
Issue Tracker github.com/docker/distribution/issues
Google Groups https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
Mailing List docker@dockerproject.org

License

This project is distributed under Apache License, Version 2.0.