mirror of
https://github.com/goharbor/harbor.git
synced 2025-02-18 04:41:26 +01:00
README and AUTHORS
This commit is contained in:
parent
4e7356acf6
commit
ffa1a3129e
10
AUTHORS
Normal file
10
AUTHORS
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
# This file lists all individuals having contributed content to the repository.
|
||||||
|
|
||||||
|
Bobby Zhang <junzhang@vmware.com>
|
||||||
|
Daniel Jiang <jiangd@vmware.com>
|
||||||
|
Haining Henry Zhang <henryzhang@vmware.com>
|
||||||
|
Hao Xia <haox@vmware.com>
|
||||||
|
Kun Wang <kunw@vmware.com>
|
||||||
|
Shan Zhu <zhus@vmware.com>
|
||||||
|
Wenkai Yin <yinw@vmware.com>
|
||||||
|
|
19
README.md
19
README.md
@ -15,17 +15,22 @@ Project Harbor is an enterprise-class registry server. It extends the open sourc
|
|||||||
* **RESTful API**: RESTful APIs are provided for most administrative operations of Harbor. The integration with other management software becomes easy.
|
* **RESTful API**: RESTful APIs are provided for most administrative operations of Harbor. The integration with other management software becomes easy.
|
||||||
|
|
||||||
### 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.
|
||||||
**System requirements:** Harbor only works with docker 1.8+ and docker-compose 1.6.0+ .
|
|
||||||
|
|
||||||
* Get the source code:
|
**System requirements:**
|
||||||
|
Harbor only works with docker 1.8+ and docker-compose 1.6.0+ .
|
||||||
|
The host must be connected to the Internet.
|
||||||
|
|
||||||
|
1. Get the source code:
|
||||||
```sh
|
```sh
|
||||||
$ git clone https://github.com/vmware/harbor
|
$ git clone https://github.com/vmware/harbor
|
||||||
```
|
```
|
||||||
|
|
||||||
* Edit the file Deploy/harbor.cfg, make necessary configuration changes such as host name, admin password and mail server. 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.
|
2. Edit the file **Deploy/harbor.cfg**, make necessary configuration changes such as host name, admin password and mail server. Refer to [Installation Guide](docs/installation_guide.md) for more info.
|
||||||
|
|
||||||
|
|
||||||
|
3. Install Harbor by the following commands. It may take a while for the docker-compose process to finish.
|
||||||
```sh
|
```sh
|
||||||
$ cd Deploy
|
$ cd Deploy
|
||||||
|
|
||||||
@ -40,9 +45,9 @@ $ docker-compose up
|
|||||||
If everything works fine, you can open a browser to visit the admin portal at: http://yourhostname . The default administrator username and password is admin/Harbor12345 .
|
If everything works fine, you can open a browser to visit the admin portal at: http://yourhostname . The default administrator username and password is admin/Harbor12345 .
|
||||||
|
|
||||||
**NOTE:**
|
**NOTE:**
|
||||||
*To simplify the installation process, a pre-built package of Harbor is provided so that you don't need to clone the source code. By using this package, 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) .
|
To simplify the installation process, a pre-built installation package of Harbor is provided so that you don't need to clone the source code. By using this package, you can even install Harbor onto a host that is not connected to the Internet. For details on how to download and use this 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) .
|
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.
|
||||||
|
Loading…
Reference in New Issue
Block a user