The toolkit to pack, ship, store, and deliver container content
Find a file
Richard Scothern 5b8592b72c Merge pull request #1475 from dmcgowan/oauth-registry-client
Add oauth support to registry client auth
2016-03-04 11:51:53 -08:00
cmd Implements garbage collection subcommand 2016-02-29 14:15:21 -08:00
configuration Add option to disable signatures 2016-02-10 15:20:39 -08:00
context Typo fixes in comments 2016-02-10 16:26:29 -08:00
contrib Attempt to unblock the ceph build process 2016-02-05 14:02:01 -08:00
digest Typo fixes in comments 2016-02-10 16:26:29 -08:00
docs Merge pull request #1364 from aaronlehmann/content-type-in-api-docs 2016-03-01 13:53:49 -08:00
Godeps Implements garbage collection subcommand 2016-02-29 14:15:21 -08:00
health Add headers parameter for HTTP checker 2015-08-20 15:11:16 -07:00
manifest Add option to disable signatures 2016-02-10 15:20:39 -08:00
notifications Typo fixes in comments 2016-02-10 16:26:29 -08: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 Add options struct to initialize handler 2016-03-04 11:32:48 -08: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
version update version file 2016-02-04 10:58:06 -08:00
.drone.yml Fix goverall 2014-11-22 10:17:14 -08:00
.gitignore Improve context package 2015-04-01 15:40:21 -07:00
.mailmap Update maintainers and authors 2016-02-04 10:40:51 -08:00
AUTHORS Update maintainers and authors 2016-02-04 10:40:51 -08:00
blobs.go Implements garbage collection subcommand 2016-02-29 14:15:21 -08:00
circle.yml Upgrade CI to go 1.5.3 2016-01-13 18:25:20 -08:00
CONTRIBUTING.md Fix some typos in comments and strings 2016-02-23 22:33:38 +01:00
coverpkg.sh Enables cross-package code coverage reporting 2015-12-21 17:09:38 -08:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile Implements garbage collection subcommand 2016-02-29 14:15:21 -08: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 Makefile: remove AUTHORS from default target 2016-02-22 12:56:23 -08:00
manifests.go Implements garbage collection subcommand 2016-02-29 14:15:21 -08:00
README.md Fix deadlink to license file 2016-02-18 17:12:51 +09:00
registry.go Implements garbage collection subcommand 2016-02-29 14:15:21 -08: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.