The toolkit to pack, ship, store, and deliver container content
Find a file
Milos Gajdos 3fc1216dc3
Merge pull request #4072 from NeilW/zero-byte-append-check
driver testsuite: Add zero byte file checks
2023-09-27 22:04:05 +01:00
.github/workflows update to go1.20.8 2023-09-12 00:07:34 +02:00
cmd Add make targets to allow starting local cloud storage environment. 2023-09-25 23:47:49 +01:00
configuration Merge pull request #4023 from DavidSpek/remove-schema1-manifest 2023-08-29 11:38:45 +01:00
context Enable bodyclose linter 2023-08-19 09:45:44 +01:00
digestset digestset: deprecate package in favor of go-digest/digestset 2022-11-08 23:17:10 +01:00
dockerfiles update to go1.20.8 2023-09-12 00:07:34 +02:00
docs docs: remove README.md that point to Docker's repo 2023-09-27 16:40:13 +08:00
health Enable bodyclose linter 2023-08-19 09:45:44 +01:00
manifest feat!: remove schema1 manifest 2023-08-29 12:17:44 +02:00
metrics Add notification metrics 2019-02-15 21:14:57 +08:00
notifications deprecate reference package, migrate to github.com/distribution/reference 2023-08-31 15:47:06 +02:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
reference deprecate reference package, migrate to github.com/distribution/reference 2023-08-31 15:47:06 +02:00
registry driver testsuite: Add zero byte file checks 2023-09-26 10:48:46 +01:00
releases docs: update release-tool link 2021-08-23 00:01:41 -07:00
tests Update Makefile and docker-compose 2023-09-26 14:41:42 +01:00
testutil Enable prealloc linter 2023-09-03 22:41:51 +01:00
uuid Only enable uuid generation warning when using registry handlers 2015-07-30 14:27:07 -07:00
vendor Support systemd socket-activation 2023-09-20 09:37:22 -07:00
version format code with gofumpt 2022-11-03 22:48:20 +01:00
.dockerignore Dockerfile: switch to xx 2022-05-03 20:07:07 +02:00
.gitignore Add make targets to allow starting local cloud storage environment. 2023-09-25 23:47:49 +01:00
.golangci.yml Enable prealloc linter 2023-09-03 22:41:51 +01:00
.mailmap Update mailmap file 2018-09-26 11:15:01 -07:00
ADOPTERS.md add double newlines in ADOPTERS.md 2023-02-14 14:51:41 +02:00
blobs.go deprecate reference package, migrate to github.com/distribution/reference 2023-08-31 15:47:06 +02:00
BUILDING.md Update BUILDING.md 2023-09-26 15:33:43 +01:00
CODE-OF-CONDUCT.md Update Code of Conduct 2023-08-02 18:16:54 +01:00
CONTRIBUTING.md Review contributing for Docker references 2022-07-08 13:52:12 +01:00
distribution-logo.svg Update distribution logo 2021-06-15 13:29:58 -07:00
doc.go fix some typos in source comments 2015-04-17 12:39:52 +00:00
docker-bake.hcl ci: git validation target 2022-07-20 14:18:27 +02:00
Dockerfile update to go1.20.8 2023-09-12 00:07:34 +02:00
errors.go Enable prealloc linter 2023-09-03 22:41:51 +01:00
go.mod Support systemd socket-activation 2023-09-20 09:37:22 -07:00
go.sum Support systemd socket-activation 2023-09-20 09:37:22 -07:00
GOVERNANCE.md Remove duplicate code of conduct 2021-03-01 12:22:06 -08:00
LICENSE Initial commit 2014-12-22 15:49:26 -08:00
MAINTAINERS Update milosgajdos maintainer email 2023-08-24 15:54:38 +01:00
Makefile Update Makefile 2023-09-26 17:24:04 +01:00
manifests.go Fix gometalint errors 2019-02-04 16:01:04 -08:00
README.md Add make targets to allow starting local cloud storage environment. 2023-09-25 23:47:49 +01:00
registry.go deprecate reference package, migrate to github.com/distribution/reference 2023-08-31 15:47:06 +02:00
ROADMAP.md Update roadmap, add code of conduct file 2021-01-26 11:34:53 +00:00
SECURITY.md Bump to 2.8.x as the current version 2023-05-01 09:39:58 +01:00
tags.go Migrate to golangci-lint 2020-02-14 08:11:16 +11:00

Build Status GoDoc License: Apache-2.0 codecov FOSSA Status OCI Conformance OpenSSF Scorecard

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.

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