harbor/README.md

65 lines
5.1 KiB
Markdown
Raw Normal View History

2016-03-28 16:21:06 +02:00
# Harbor
[![Build Status](https://travis-ci.org/vmware/harbor.svg?branch=master)](https://travis-ci.org/vmware/harbor)
[![Coverage Status](https://coveralls.io/repos/github/vmware/harbor/badge.svg?branch=dev)](https://coveralls.io/github/vmware/harbor?branch=dev)
2016-03-28 16:21:06 +02:00
2016-08-20 16:50:21 +02:00
<img alt="Harbor" src="docs/img/harbor_logo.png">
2016-03-28 16:21:06 +02:00
Project Harbor is an enterprise-class registry server that stores and distributes Docker images. Harbor extends the open source Docker Distribution by adding the functionalities usually required by an enterprise, such as security, identity and management. As an enterprise private registry, Harbor offers better performance and security. Having a registry closer to the build and run environment improves the image transfer efficiency. Harbor supports the setup of multiple registries and has images replicated between them. With Harbor, the images are stored within the private registry, keeping the bits and intellectual properties behind the company firewall. In addition, Harbor offers advanced security features, such as user management, access control and activity auditing.
2016-03-28 16:21:06 +02:00
### Features
* **Role based access control**: Users and repositories are organized via 'projects' and a user can have different permission for images under a project.
2016-11-01 15:52:34 +01:00
* **Policy based image replication**: Images can be replicated (synchronized) between multiple registry instances. Great for load balancing, high availability, multi-datacenter, hybrid and multi-cloud scenarios.
* **LDAP/AD support**: Harbor integrates with existing enterprise LDAP/AD for user authentication and management.
* **Image deletion & garbage collection**: Images can be deleted and their space can be recycled.
* **Graphical user portal**: User can easily browse, search repositories and manage projects.
2016-05-11 18:37:35 +02:00
* **Auditing**: All the operations to the repositories are tracked.
* **RESTful API**: RESTful APIs for most administrative operations, easy to integrate with external systems.
2016-11-01 15:52:34 +01:00
* **Easy deployment**: Provide both an online and offline installer. Besides, a virtual appliance for vSphere platform (OVA) is available.
2016-03-28 16:21:06 +02:00
2016-11-01 15:52:34 +01:00
### Install & Run
2016-03-28 16:21:06 +02:00
**System requirements:**
Harbor only works with docker 1.10.0+ and docker-compose 1.6.0+.
2016-11-01 15:52:34 +01:00
Download binaries of **[Harbor release ](https://github.com/vmware/harbor/releases)** and follow **[Installation & Confiugration Guide](docs/installation_guide.md)** to install Harbor.
After installation, if everything worked properly, you should be able to open a browser to visit the admin portal at http://reg.yourdomain.com. Note that the default administrator username/password are admin/Harbor12345.
2016-04-08 11:04:47 +02:00
Log in to the admin portal and create a new project, e.g. `myproject`. You can then use docker commands to login and push images (by default, the registry server listens on port 80):
2016-03-28 16:21:06 +02:00
```sh
2016-04-08 11:04:47 +02:00
$ docker login reg.yourdomain.com
2016-08-20 16:50:21 +02:00
$ docker push reg.yourdomain.com/myproject/myrepo:mytag
2016-03-28 16:21:06 +02:00
```
2016-11-01 15:52:34 +01:00
Refer to **[User Guide](docs/user_guide.md)** for more details on how to use Harbor.
2016-03-28 16:21:06 +02:00
2016-08-03 08:28:26 +02:00
### Community
2016-11-01 15:52:34 +01:00
**Slack:** Join Harbor's community here: [VMware {code}](https://code.vmware.com/join/) Slack group, Channel: #harbor.
**Email:** harbor@ vmware.com .
**WeChat:** Add WeChat id *connect1688* to join WeChat discussion group.
2016-08-03 08:28:26 +02:00
2016-03-28 16:21:06 +02:00
### Contribution
2016-11-01 15:52:34 +01:00
We welcome contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a pull request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq). Contact us for any qustions: harbor@ vmware.com .
2016-03-28 16:21:06 +02:00
### License
Harbor is available under the [Apache 2 license](LICENSE).
2016-03-29 03:39:37 +02:00
2016-08-29 16:57:22 +02:00
This project uses open source components which have additional licensing terms. The official docker images and licensing terms for these open source components can be found at the following locations:
2016-08-29 06:01:07 +02:00
* Photon OS 1.0: [docker image](https://hub.docker.com/_/photon/), [license](https://github.com/vmware/photon/blob/master/COPYING)
* Docker Registry 2.5: [docker image](https://hub.docker.com/_/registry/), [license](https://github.com/docker/distribution/blob/master/LICENSE)
* MySQL 5.6: [docker image](https://hub.docker.com/_/mysql/), [license](https://github.com/docker-library/mysql/blob/master/LICENSE)
* NGINX 1.9: [docker image](https://hub.docker.com/_/nginx/), [license](https://github.com/nginxinc/docker-nginx/blob/master/LICENSE)
2016-03-29 03:53:34 +02:00
### Partners
2016-03-31 05:37:08 +02:00
<a href="https://www.shurenyun.com/" border="0" target="_blank"><img alt="DataMan" src="docs/img/dataman.png"></a> &nbsp; &nbsp; <a href="http://www.slamtec.com" target="_blank" border="0"><img alt="SlamTec" src="docs/img/slamteclogo.png"></a>
2016-05-17 11:32:10 +02:00
&nbsp; &nbsp; <a href="https://www.caicloud.io" border="0"><img alt="CaiCloud" src="docs/img/caicloudLogoWeb.png"></a>
2016-03-29 03:53:34 +02:00
2016-03-29 03:39:37 +02:00
### Users
2016-06-06 06:07:30 +02:00
<a href="https://www.madailicai.com/" border="0" target="_blank"><img alt="MaDaiLiCai" src="docs/img/UserMaDai.jpg"></a> <a href="https://www.dianrong.com/" border="0" target="_blank"><img alt="Dianrong" src="docs/img/dianrong.png"></a>
2016-04-14 09:57:42 +02:00
### Supporting Technologies
2016-07-19 11:56:55 +02:00
<img alt="beego" src="docs/img/beegoLogo.png"> Harbor is powered by <a href="http://beego.me/">Beego</a>.