The toolkit to pack, ship, store, and deliver container content
Find a file
2024-03-05 17:22:26 +00:00
.github build(deps): bump codecov/codecov-action from 3 to 4 2024-02-01 01:51:49 +00:00
cmd feat(linter): enable errcheck linter in golangci-lint 2023-11-18 07:19:24 +00:00
configuration feat: Add HTTP2 for unencrypted HTTP 2024-01-17 20:59:02 +00:00
digestset digestset: deprecate package in favor of go-digest/digestset 2022-11-08 23:17:10 +01:00
dockerfiles docs: add rendering hook and fix broken links (#4247) 2024-01-17 08:18:02 +07:00
docs Update notifications.md 2024-02-28 13:32:59 -05:00
health cleanup: move init funcs to the top of the source 2023-11-28 06:50:48 +00:00
internal fix: typo 2024-03-04 11:00:08 +08:00
manifest Add annotation for descriptor 2023-10-16 19:03:12 +08:00
metrics Add prometheus proxy related metrics 2023-10-23 19:59:22 +03:00
notifications cleanup: move init funcs to the top of the source 2023-11-28 06:50:48 +00:00
project Adds pre-commit hook, hook config script, and a README 2014-12-15 18:09:11 -08:00
registry Added Open Telemetry Tracing to Filesystem package 2024-03-04 13:31:22 +01:00
releases release: prep for the v3 alpha-1 release 2023-12-19 15:11:25 +00:00
tests ci: add cloud storage driver integration tests to CI 2023-10-25 17:17:50 +01:00
testutil feat(linter): enable errcheck linter in golangci-lint 2023-11-18 07:19:24 +00:00
tracing Standardize OTEL error logging format to match application logs 2024-03-05 07:22:10 +01:00
vendor feat: Add HTTP2 for unencrypted HTTP 2024-01-17 20:59:02 +00:00
version version: export getter functions 2023-12-19 13:02:44 -05:00
.dockerignore Dockerfile: switch to xx 2022-05-03 20:07:07 +02:00
.gitignore docs: add hugo site 2023-10-11 16:45:16 +02:00
.golangci.yml feat: add tparallel linter to improve handling parallel tests 2023-11-29 21:40:20 +00:00
.mailmap chore: update mailmap 2023-12-29 12:13:00 +01:00
ADOPTERS.md add double newlines in ADOPTERS.md 2023-02-14 14:51:41 +02:00
AUTHORS chore: generate authors 2023-12-29 12:13:49 +01:00
blobs.go remove deprecated ReadSeekCloser interfaces 2024-01-06 12:08:21 +01:00
BUILDING.md update: remove gcs storage driver build tags 2023-12-10 09:09:52 +00: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 Cleanup of naming in docs 2023-10-12 11:39:36 +01:00
docker-bake.hcl docs: fix broken links and improve link resolution 2024-01-14 21:33:55 +01:00
Dockerfile fix: update Dockerfile version output (#4212) 2024-01-16 17:07:04 +07:00
errors.go Enable prealloc linter 2023-09-03 22:41:51 +01:00
go.mod Added Open Telemetry Tracing to Filesystem package 2024-03-04 13:31:22 +01:00
go.sum feat: Add HTTP2 for unencrypted HTTP 2024-01-17 20:59:02 +00:00
GOVERNANCE.md Cleanup of naming in docs 2023-10-12 11:39:36 +01: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 chore: generate authors 2023-12-29 12:13:49 +01:00
manifests.go Fix gometalint errors 2019-02-04 16:01:04 -08:00
README.md update: readme cleanup and fxes 2023-12-21 22:05:56 +00: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 and other content 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 Full documentation is available at https://distribution.github.io/distribution.

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