The toolkit to pack, ship, store, and deliver container content
Find a file
Aaron Lehmann 5e4ea38a2f Merge pull request #1425 from RichardScothern/fix-build
Correct type for repo reference
2016-02-04 17:47:03 -08:00
cmd fix yml indent 2016-02-03 17:59:49 +02:00
configuration Add http.host parameter 2015-09-30 15:12:01 -07:00
context Add go version to logger output 2015-10-22 10:11:25 -07:00
contrib Update to address comments 2016-01-28 15:47:22 -08:00
digest digest: add NewDigestFromBytes for completeness 2016-01-06 18:00:20 -08:00
docs Merge pull request #1401 from BrianBland/s3StorageClass 2016-02-04 16:44:13 -08:00
Godeps Updates docker/goamz dependency to support AWS profile env 2016-02-02 18:10:03 -08:00
health Add headers parameter for HTTP checker 2015-08-20 15:11:16 -07:00
manifest Use reference package internally 2016-01-22 14:47:05 -08:00
notifications Rename Name method of Repository to Named 2016-02-04 09:55:36 -08:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference Fix godoc 2015-12-22 12:26:05 +01:00
registry Correct type for repo reference 2016-02-04 17:32:55 -08:00
testutil Remove tarsum support for digest package 2015-12-15 17:22:18 -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 Adds functional options arguments to the Blobs Create method 2016-01-13 16:42:59 -08:00
circle.yml Upgrade CI to go 1.5.3 2016-01-13 18:25:20 -08:00
CONTRIBUTING.md Forbid commenting on closed issues 2015-08-12 10:45:42 -07: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 Update to Go 1.5.3. 2016-01-14 10:40:20 -08:00
errors.go Implementation of the Manifest Service API refactor. 2015-12-17 17:09:14 -08: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 Use go 1.5 on the build machine 2015-11-11 09:50:59 -08:00
manifests.go Add manifest put by digest to the registry client 2016-01-26 14:20:23 -08:00
README.md Update links to documentation 2015-12-21 01:22:01 +01:00
registry.go Rename Name method of Repository to Named 2016-02-04 09:55:36 -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.