The toolkit to pack, ship, store, and deliver container content
Find a file
Tom Hu c95293bbdf Add Codecov badge
Signed-off-by: Tom Hu <tomhu1096@gmail.com>
2021-02-10 13:38:38 -05:00
.github go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
cmd go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
configuration Merge pull request #2446 from legionus/docker-configuration-ptr 2020-02-22 16:42:17 -08:00
context go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
contrib go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
digestset Enable static checks 2018-08-06 14:49:11 -07:00
docs go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
health go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
manifest go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
metrics Add notification metrics 2019-02-15 21:14:57 +08:00
notifications go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
registry go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
releases go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
script Merge pull request #3229 from thaJeztah/remove_md2man 2021-02-06 16:02:20 +00:00
testutil go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor Bump Gorilla Handlers to v1.5.1. 2020-11-06 10:22:21 -08:00
version go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
.gitignore add s3 region filters for cloudfront 2017-12-01 15:58:58 -08:00
.golangci.yml Migrate to golangci-lint 2020-02-14 08:11:16 +11:00
.mailmap Update mailmap file 2018-09-26 11:15:01 -07:00
ADOPTERS.md Add Adopters 2020-12-09 17:44:18 +00:00
blobs.go go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
BUILDING.md go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
CODE-OF-CONDUCT.md Update roadmap, add code of conduct file 2021-01-26 11:34:53 +00:00
CONTRIBUTING.md Revert "Merge branch 'main' of https://github.com/distribution/distribution into main" 2021-02-01 10:52:22 -05:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
Dockerfile go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
errors.go disable schema1 by default, add a config flag to enable it 2017-12-19 10:23:25 -08:00
go.mod go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
go.sum Bump Gorilla Handlers to v1.5.1. 2020-11-06 10:22:21 -08:00
GOVERNANCE.md go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Propose two maintainers from Mirantis 2021-02-02 14:57:53 +00:00
Makefile go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
manifests.go Fix gometalint errors 2019-02-04 16:01:04 -08:00
README.md Add Codecov badge 2021-02-10 13:38:38 -05:00
registry.go go.mod: change imports to github.com/distribution/distribution/v3 2021-02-08 18:30:46 +01:00
ROADMAP.md Update roadmap, add code of conduct file 2021-01-26 11:34:53 +00:00
tags.go Migrate to golangci-lint 2020-02-14 08:11:16 +11:00

Distribution

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

This repository's main product is the Open Source Registry implementation for storing and distributing container images using the OCI Distribution Specification. The goal of this project is to provide a simple, secure, and scalable base for building a large scale registry solution or running a simple private registry. It is a core library for many registry operators including Docker Hub, GitHub Container Registry, GitLab Container Registry and DigitalOcean Container Registry, as well as the CNCF Harbor Project, and VMware Harbor Registry.

Build Status GoDoc License: Apache-2.0 codecov

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.

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 #distribution channel in the CNCF Slack that everyone is welcome to join and chat about development.

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/.