Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-12-22 16:48:30 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #19 from hainingzhang/master

Browse Source 
Update README.md
This commit is contained in:
reasonerjt 2016-03-09 23:12:40 +08:00
commit bde05a6177
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -4,7 +4,7 @@
![alg tag](https://cloud.githubusercontent.com/assets/2390463/13484557/088a1000-e13a-11e5-87d4-a64366365bef.png) ![alg tag](https://cloud.githubusercontent.com/assets/2390463/13484557/088a1000-e13a-11e5-87d4-a64366365bef.png)
Project Harbor is an enterprise-class registry server. It extends the open source Docker Registry server by adding more functionalities usually required by an enterprise. Harbor is designed to be deployed in a private environment of an organization. A private registry is important for organizations who care much about security. In addition, a private registry improves productivity by eliminating the need to download images from public network. This is very helpful to container users who do not have a good network to the Internet. In particular, Harbor accelerates the progress of Chinese developers, because they no longer need to pull images from the Internet. Project Harbor is an enterprise-class registry server. It extends the open source Docker Registry server by adding more functionalities usually required by an enterprise. Harbor is designed to be deployed in a private environment of an organization. A private registry is important for organizations who care much about security. In addition, a private registry improves productivity by eliminating the need to download images from public network. This is very helpful to container users who do not have a good network to the Internet. For example, Harbor accelerates the progress of Chinese developers, because they no longer need to pull images from the Internet.
### Features ### Features
* **Role Based Access Control**: Users and docker repositories are organized via "projects", a user can have differernt permission for images under a namespace. * **Role Based Access Control**: Users and docker repositories are organized via "projects", a user can have differernt permission for images under a namespace.
@ -16,12 +16,18 @@ Project Harbor is an enterprise-class registry server. It extends the open sourc
### Try it ### Try it
Harbor is self contained and can be easily deployed via docker-compose. Harbor is self contained and can be easily deployed via docker-compose.
**pre-requisite:** Harbor only works on linux OS, with docker 1.8+ and docker-compose 1.6.0+ **System requirements:** Harbor only works with docker 1.8+ and docker-compose 1.6.0+ .
* Get the source code:
```sh ```sh
$ git clone https://github.com/vmware/harbor $ git clone https://github.com/vmware/harbor
...... ```
* Make necessary configuration changes to the file Deploy/harbor.cfg . Refer to [Installation Guide](docs/installation_guide.md) for more info.
* Install Harbor by the following commands. It may take a while for the docker-compose process to finish.
```sh
$ cd Deploy $ cd Deploy
#make update to the parameters in ./harbor.cfg
$ ./prepare $ ./prepare
Generated configuration file: ./config/ui/env Generated configuration file: ./config/ui/env
Generated configuration file: ./config/ui/app.conf Generated configuration file: ./config/ui/app.conf
@ -29,9 +35,10 @@ Generated configuration file: ./config/registry/config.yml
Generated configuration file: ./config/db/env Generated configuration file: ./config/db/env
$ docker-compose up $ docker-compose up
``` ```
*An installation package is provided, such that you don't need to clone the whole repo. For details on how to use the installation package and parameters in harbor.cfg, please refer to:* [Installation Guide](docs/installation_guide.md)
*For information on how to use Harbor, please see* [User Guide](docs/user_guide.md) *An installation package is provided, such that you don't need to clone the whole repo. You can even install Harbor onto a host that is not connected to the Internet. For details on how to download and use the installation package, please refer to* [Installation Guide](docs/installation_guide.md) .
*For information on how to use Harbor, please see* [User Guide](docs/user_guide.md) .
### Contribution ### Contribution
We welcome contributions from the community. If you wish to contribute code, we require that you first sign our [Contributor License Agreement](https://vmware.github.io/photon/assets/files/vmware_cla.pdf) and return a copy to osscontributions@vmware.com before we can merge your contribution. We welcome contributions from the community. If you wish to contribute code, we require that you first sign our [Contributor License Agreement](https://vmware.github.io/photon/assets/files/vmware_cla.pdf) and return a copy to osscontributions@vmware.com before we can merge your contribution.