The toolkit to pack, ship, store, and deliver container content
Find a file
Derek McGowan 32e2260be2
Enable struct check
Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2018-08-06 13:55:43 -07:00
cmd Add Prometheus Metrics 2018-02-09 14:27:51 -08:00
configuration Merge pull request #2501 from xiaonancc77/master 2018-03-14 10:37:02 -07:00
context context, registry/handlers: remove net/context references 2018-01-17 16:01:41 -08:00
contrib Update certificates 2018-05-21 16:00:52 -07:00
digestset digestset: refine some words on unit test 2017-10-31 16:33:36 +08:00
docs Merge pull request #2501 from xiaonancc77/master 2018-03-14 10:37:02 -07:00
health fix typos in comment 2017-02-27 14:06:18 +08:00
manifest address review comment regarding panic use 2018-07-19 16:07:26 -05:00
metrics Add Prometheus Metrics 2018-02-09 14:27:51 -08:00
notifications Added ignore event typs into notifications 2018-03-13 16:00:44 +08:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference reference: allow more than 1 digest algorithm separator 2017-04-24 15:14:12 -07:00
registry Enable struct check 2018-08-06 13:55:43 -07:00
script Update build to use travis 2018-08-01 16:54:54 -07:00
testutil digest: migrate to opencontainers/go-digest 2017-01-06 15:42:03 -08:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor update to image spec v1.0.0 2018-06-18 13:55:24 -05:00
version Update build to use travis 2018-08-01 16:54:54 -07:00
.gitignore add s3 region filters for cloudfront 2017-12-01 15:58:58 -08:00
.gometalinter.json Enable struct check 2018-08-06 13:55:43 -07:00
.mailmap Prepare for the release. 2016-06-13 16:03:16 -07:00
.travis.yml Update build to use travis 2018-08-01 16:54:54 -07:00
AUTHORS Release preperation: update AUTHORS and version file 2016-11-11 09:23:05 -08:00
blobs.go OCI media types; annotation support; oci index 2018-06-18 13:48:58 -05:00
BUILDING.md fix out of date cli arg for registry version 2018-02-28 06:46:06 +08:00
CHANGELOG.md Update release notes for 2.6 2017-01-17 16:16:05 -08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2017-12-29 14:41:43 +02:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile Update Golang to 1.10 2018-05-22 19:42:22 +02:00
errors.go Use errors.New() to output the error message and fix some typos 2017-02-20 10:39:58 +08:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Prepare for the release. 2016-06-13 16:03:16 -07:00
Makefile Update build to use travis 2018-08-01 16:54:54 -07:00
manifests.go context: remove definition of Context 2017-08-11 15:53:31 -07:00
README.md DOC: README: Fix broken link in migrator 2017-04-05 19:22:18 -04:00
registry.go Allow clients to request specific manifest media types 2017-10-03 17:06:11 -04:00
RELEASE-CHECKLIST.md Update release checklist with further details 2017-01-18 11:07:35 -08:00
ROADMAP.md fix typos 2016-06-02 23:03:27 +08:00
tags.go context: remove definition of Context 2017-08-11 15:53:31 -07:00
vendor.conf update to image spec v1.0.0 2018-06-18 13:55:24 -05: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.

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.