The toolkit to pack, ship, store, and deliver container content
Find a file
Derek McGowan f5e84a4939
Update readme and contributing docs
Update project details to align more closely with community
updates in OCI and containerd.

Signed-off-by: Derek McGowan <derek@mcgstyle.net>
2019-12-13 17:20:45 -08:00
cmd import alicdn package 2019-03-19 15:06:02 +08:00
configuration Fix gometalint errors 2019-02-04 16:01:04 -08:00
context remove closenotifier 2018-09-11 16:14:10 -07:00
contrib registry: fix binary JSON content-type 2019-01-14 09:04:42 +00:00
digestset Enable static checks 2018-08-06 14:49:11 -07:00
docs replace rsc.io/letsencrypt in favour of golang.org/x/crypto 2019-06-04 12:04:18 -07:00
health Merge pull request #2813 from lucab/ups/spec-json-binary 2019-03-01 14:26:54 -08:00
manifest Fix gometalint errors 2019-02-04 16:01:04 -08:00
metrics Add notification metrics 2019-02-15 21:14:57 +08:00
notifications rename the metrics label 2019-02-17 12:46:10 +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 #2840 from manishtomar/fix-lint 2019-02-04 16:58:09 -08:00
registry Merge pull request #2950 from terinjokes/patches/swift-segment-hash 2019-07-11 15:35:31 -07:00
releases Release notes for 2.7 2018-11-29 16:35:06 -08:00
script migrate to go modules from vndr 2019-06-19 12:24:07 -07:00
testutil Enable static checks 2018-08-06 14:49:11 -07:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor update the golang compiler version and the versions of several dependencies 2019-06-19 22:43:52 -07:00
version Release notes for 2.7 2018-11-29 16:35:06 -08:00
.gitignore add s3 region filters for cloudfront 2017-12-01 15:58:58 -08:00
.gometalinter.json Merge pull request #2662 from dmcgowan/enable-structcheck 2018-08-07 19:01:38 -07:00
.mailmap Update mailmap file 2018-09-26 11:15:01 -07:00
.travis.yml update the golang compiler version and the versions of several dependencies 2019-06-19 22:43:52 -07:00
blobs.go Merge pull request #2328 from stepyu/patch-1 2018-08-23 16:02:07 -07:00
BUILDING.md fix out of date cli arg for registry version 2018-02-28 06:46:06 +08:00
code-of-conduct.md Update readme and contributing docs 2019-12-13 17:20:45 -08:00
CONTRIBUTING.md Update readme and contributing docs 2019-12-13 17:20:45 -08:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile Merge pull request #2955 from alex-laties/master 2019-07-11 15:30:23 -07:00
errors.go disable schema1 by default, add a config flag to enable it 2017-12-19 10:23:25 -08:00
go.mod update the golang compiler version and the versions of several dependencies 2019-06-19 22:43:52 -07:00
go.sum update the golang compiler version and the versions of several dependencies 2019-06-19 22:43:52 -07:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Add new reviewers 2018-08-20 12:24:15 -07:00
Makefile allow for VERSION and REVISION to be passed in during docker builds 2019-06-26 18:06:51 -04:00
manifests.go Fix gometalint errors 2019-02-04 16:01:04 -08:00
README.md Update readme and contributing docs 2019-12-13 17:20:45 -08:00
registry.go add support for repo deleted event also 2018-08-02 23:05:05 -07: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

Distribution

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

This repository's main product is the Open Source Docker Registry implementation for storing and distributing Docker and OCI images using the OCI Distribution Specification. The goal of this project is to provide a simple, secure, and scalable base for building a registry solution or running a simple private registry.

Build Status GoDoc

This repository contains the following components:

Component Description
registry An implementation of the OCI Distribution Specification.
libraries A rich set of libraries for interacting with distribution components. Please see godoc for details. Note: The interfaces for these libraries are unstable.
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, containerd, and other OCI client?

Clients implement against the OCI specification and communicate with the registry using HTTP. This project contains an client implementation which is currently in use by Docker, however, it is deprecated for the implementation in containerd and will not support new features.

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.

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.

Contribution

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.

Communication

For async communication and long running discussions please use issues and pull requests on the github repo. This will be the best place to discuss design and implementation.

For sync communication we have a community slack with a #distribution channel that everyone is welcome to join and chat about development.

Slack: Catch us in the #distribution channels on dockercommunity.slack.com. Click here for an invite to Docker community slack.

Licenses

The distribution codebase is released under the Apache 2.0 license. The README.md file, and files in the "docs" folder are licensed under the Creative Commons Attribution 4.0 International License. You may obtain a copy of the license, titled CC-BY-4.0, at http://creativecommons.org/licenses/by/4.0/.