github.com/lusis/distribution@v2.0.1+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  This repository contains the following components:
    11  
    12  |**Component**       |Description                                                                                                                                                                                         |
    13  |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    14  | **registry**       | An implementation of the [Docker Registry HTTP API V2](docs/spec/api.md) for use with docker 1.6+.                                                                                                  |
    15  | **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**. |
    16  | **dist**           | An _experimental_ tool to provide distribution, oriented functionality without the `docker` daemon.                                                                                                |
    17  | **specifications** | _Distribution_ related specifications are available in [docs/spec](docs/spec)                                                                                                                        |
    18  | **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.                                                                                                                                          |
    19  
    20  ### How does this integrate with Docker engine?
    21  
    22  This project should provide an implementation to a V2 API for use in the [Docker
    23  core project](https://github.com/docker/docker). The API should be embeddable
    24  and simplify the process of securely pulling and pushing content from `docker`
    25  daemons.
    26  
    27  ### What are the long term goals of the Distribution project?
    28  
    29  The _Distribution_ project has the further long term goal of providing a
    30  secure tool chain for distributing content. The specifications, APIs and tools
    31  should be as useful with Docker as they are without.
    32  
    33  Our goal is to design a professional grade and extensible content distribution
    34  system that allow users to:
    35  
    36  * Enjoy an efficient, secured and reliable way to store, manage, package and
    37    exchange content
    38  * Hack/roll their own on top of healthy open-source components
    39  * Implement their own home made solution through good specs, and solid
    40    extensions mechanism.
    41  
    42  ## More about Registry 2.0
    43  
    44  The new registry implementation provides the following benefits:
    45  
    46  - faster push and pull
    47  - new, more efficient implementation
    48  - simplified deployment
    49  - pluggable storage backend
    50  - webhook notifications
    51  
    52  For information on upcoming functionality, please see [ROADMAP.md](ROADMAP.md).
    53  
    54  ### Who needs to deploy a registry?
    55  
    56  By default, Docker users pull images from Docker's public registry instance.
    57  [Installing Docker](http://docs.docker.com/installation) gives users this
    58  ability. Users can also push images to a repository on Docker's public registry,
    59  if they have a [Docker Hub](https://hub.docker.com/) account. 
    60  
    61  For some users and even companies, this default behavior is sufficient. For
    62  others, it is not. 
    63  
    64  For example, users with their own software products and may want to maintain an
    65  registry for private, company images. Also, you may wish to deploy your own
    66  image repository for images used to test or in continuous integration. For these
    67  use cases and others, [deploying your own registry instance](docs/deploying.md)
    68  may be the better choice.
    69  
    70  ## Contribute
    71  
    72  Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute
    73  issues, fixes, and patches to this project. If you are contributing code, see
    74  the instructions for [building a development environment](docs/building.md).
    75  
    76  ## Support
    77  
    78  If any issues are encountered while using the _Distribution_ project, several
    79  avenues are available for support:
    80  
    81  <table>
    82  <tr>
    83  	<th align="left">
    84  	IRC
    85  	</th>
    86  	<td>
    87  	#docker-distribution on FreeNode
    88  	</td>
    89  </tr>
    90  <tr>
    91  	<th align="left">
    92  	Issue Tracker
    93  	</th>
    94  	<td>
    95  	github.com/docker/distribution/issues
    96  	</td>
    97  </tr>
    98  <tr>
    99  	<th align="left">
   100  	Google Groups
   101  	</th>
   102  	<td>
   103  	https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
   104  	</td>
   105  </tr>
   106  <tr>
   107  	<th align="left">
   108  	Mailing List
   109  	</th>
   110  	<td>
   111  	docker@dockerproject.org
   112  	</td>
   113  </tr>
   114  </table>
   115  
   116  
   117  ## License
   118  
   119  This project is distributed under [Apache License, Version 2.0](LICENSE.md).