github.com/samsalisbury/distribution@v2.2.1-0.20151123021722-54f974340220+incompatible/README.md (about) 1 # Distribution 2 3 The Docker toolset to pack, ship, store, and deliver content. 4 5 This repository's main product is the Docker Registry 2.0 implementation 6 for storing and distributing Docker images. It supersedes the [docker/docker- 7 registry](https://github.com/docker/docker-registry) project with a new API 8 design, focused around security and performance. 9 10 <img src="https://www.docker.com/sites/default/files/oyster-registry-3.png" width=200px/> 11 12 [![Circle CI](https://circleci.com/gh/docker/distribution/tree/master.svg?style=svg)](https://circleci.com/gh/docker/distribution/tree/master) 13 [![GoDoc](https://godoc.org/github.com/docker/distribution?status.svg)](https://godoc.org/github.com/docker/distribution) 14 15 This repository contains the following components: 16 17 |**Component** |Description | 18 |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 19 | **registry** | An implementation of the [Docker Registry HTTP API V2](docs/spec/api.md) for use with docker 1.6+. | 20 | **libraries** | A rich set of libraries for interacting with,distribution components. Please see [godoc](http://godoc.org/github.com/docker/distribution) for details. **Note**: These libraries are **unstable**. | 21 | **specifications** | _Distribution_ related specifications are available in [docs/spec](docs/spec) | 22 | **documentation** | Docker's full documentation set is available at [docs.docker.com](http://docs.docker.com). This repository [contains the subset](docs/index.md) related just to the registry. | 23 24 ### How does this integrate with Docker engine? 25 26 This project should provide an implementation to a V2 API for use in the [Docker 27 core project](https://github.com/docker/docker). The API should be embeddable 28 and simplify the process of securely pulling and pushing content from `docker` 29 daemons. 30 31 ### What are the long term goals of the Distribution project? 32 33 The _Distribution_ project has the further long term goal of providing a 34 secure tool chain for distributing content. The specifications, APIs and tools 35 should be as useful with Docker as they are without. 36 37 Our goal is to design a professional grade and extensible content distribution 38 system that allow users to: 39 40 * Enjoy an efficient, secured and reliable way to store, manage, package and 41 exchange content 42 * Hack/roll their own on top of healthy open-source components 43 * Implement their own home made solution through good specs, and solid 44 extensions mechanism. 45 46 ## More about Registry 2.0 47 48 The new registry implementation provides the following benefits: 49 50 - faster push and pull 51 - new, more efficient implementation 52 - simplified deployment 53 - pluggable storage backend 54 - webhook notifications 55 56 For information on upcoming functionality, please see [ROADMAP.md](ROADMAP.md). 57 58 ### Who needs to deploy a registry? 59 60 By default, Docker users pull images from Docker's public registry instance. 61 [Installing Docker](http://docs.docker.com/installation) gives users this 62 ability. Users can also push images to a repository on Docker's public registry, 63 if they have a [Docker Hub](https://hub.docker.com/) account. 64 65 For some users and even companies, this default behavior is sufficient. For 66 others, it is not. 67 68 For example, users with their own software products may want to maintain a 69 registry for private, company images. Also, you may wish to deploy your own 70 image repository for images used to test or in continuous integration. For these 71 use cases and others, [deploying your own registry instance](docs/deploying.md) 72 may be the better choice. 73 74 ### Migration to Registry 2.0 75 76 For those who have previously deployed their own registry based on the Registry 77 1.0 implementation and wish to deploy a Registry 2.0 while retaining images, 78 data migration is required. A tool to assist with migration efforts has been 79 created. For more information see [docker/migrator] 80 (https://github.com/docker/migrator). 81 82 ## Contribute 83 84 Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute 85 issues, fixes, and patches to this project. If you are contributing code, see 86 the instructions for [building a development environment](docs/building.md). 87 88 ## Support 89 90 If any issues are encountered while using the _Distribution_ project, several 91 avenues are available for support: 92 93 <table> 94 <tr> 95 <th align="left"> 96 IRC 97 </th> 98 <td> 99 #docker-distribution on FreeNode 100 </td> 101 </tr> 102 <tr> 103 <th align="left"> 104 Issue Tracker 105 </th> 106 <td> 107 github.com/docker/distribution/issues 108 </td> 109 </tr> 110 <tr> 111 <th align="left"> 112 Google Groups 113 </th> 114 <td> 115 https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution 116 </td> 117 </tr> 118 <tr> 119 <th align="left"> 120 Mailing List 121 </th> 122 <td> 123 docker@dockerproject.org 124 </td> 125 </tr> 126 </table> 127 128 129 ## License 130 131 This project is distributed under [Apache License, Version 2.0](LICENSE.md).