The toolkit to pack, ship, store, and deliver container content
 
 
 
 
 
Go to file
Milos Gajdos e4a447d0d7
Merge pull request #3595 from crazy-max/2.8-ci-gitref
[2.8 backport] ci: use proper git ref for versioning
2022-02-23 08:59:59 +00:00
.github/workflows [2.8] Release artifacts 2022-01-19 16:54:30 +01:00
cmd Migrate to golangci-lint 2021-03-23 21:02:54 +08:00
configuration Merge pull request #3384 from wy65701436/release/2.7-cp-3169 2021-03-23 15:23:04 +00:00
context remove closenotifier 2018-09-11 16:14:10 -07:00
contrib fix go check issues 2021-11-16 17:46:08 +08:00
digestset
docs Change should to must in v2 spec 2021-09-08 15:24:07 +02:00
health Fix gometalint errors 2021-03-23 21:03:10 +08:00
manifest manifest: validate document type before unmarshal 2021-11-05 10:16:09 -07:00
metrics
notifications Fix gometalint errors 2021-03-23 21:03:10 +08:00
project
reference Fix gometalint errors 2021-03-23 21:03:10 +08:00
registry fix go check issues 2021-11-16 17:46:08 +08:00
releases Apply suggestions from code review 2021-12-22 09:13:32 +00:00
script Fix gosimple checks 2021-03-23 21:03:20 +08:00
testutil
uuid
vendor Merge pull request #3466 from thaJeztah/2.7_update_jwt 2021-11-23 09:10:53 +00:00
version Make this releaes a beta release first. 2022-01-21 11:36:41 +00:00
.gitignore
.golangci.yml Migrate to golangci-lint 2021-03-23 21:02:54 +08:00
.mailmap Prepare for v2.8.0 release 2021-12-21 13:24:39 +00:00
BUILDING.md
CONTRIBUTING.md
Dockerfile ci: use proper git ref for versioning 2022-02-22 22:05:10 +01:00
LICENSE
MAINTAINERS
Makefile Migrate to golangci-lint 2021-03-23 21:02:54 +08:00
README.md Update README so the release pipeline works properly. 2022-02-07 15:40:21 +00:00
ROADMAP.md
blobs.go Migrate to golangci-lint 2021-03-23 21:02:54 +08:00
doc.go
docker-bake.hcl ci: use proper git ref for versioning 2022-02-22 22:05:10 +01:00
errors.go
manifests.go Fix gometalint errors 2021-03-23 21:03:10 +08:00
registry.go
tags.go
vendor.conf Merge pull request #3466 from thaJeztah/2.7_update_jwt 2021-11-23 09:10:53 +00:00

README.md

Distribution

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

This repository provides 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.