Merge pull request #799 from hainingzhang/master

README
This commit is contained in:
Haining Henry Zhang 2016-09-13 21:18:06 +08:00 committed by GitHub
commit 8e6ceab29b
2 changed files with 34 additions and 2 deletions

View File

@ -12,7 +12,6 @@ Project Harbor is an enterprise-class registry server that stores and distribute
* **Graphical user portal**: User can easily browse, search repositories and manage projects. * **Graphical user portal**: User can easily browse, search repositories and manage projects.
* **AD/LDAP support**: Harbor integrates with existing enterprise AD/LDAP for user authentication and management. * **AD/LDAP support**: Harbor integrates with existing enterprise AD/LDAP for user authentication and management.
* **Auditing**: All the operations to the repositories are tracked. * **Auditing**: All the operations to the repositories are tracked.
* **Internationalization**: Already localized for English, Chinese, German, Japanese and Russian. More languages can be added.
* **RESTful API**: RESTful APIs for most administrative operations, easy to integrate with external systems. * **RESTful API**: RESTful APIs for most administrative operations, easy to integrate with external systems.
* **Easy deployment**: docker compose and offline installer. * **Easy deployment**: docker compose and offline installer.
@ -91,4 +90,4 @@ This project uses open source components which have additional licensing terms.
<img alt="beego" src="docs/img/beegoLogo.png"> Harbor is powered by <a href="http://beego.me/">Beego</a>. <img alt="beego" src="docs/img/beegoLogo.png"> Harbor is powered by <a href="http://beego.me/">Beego</a>.
### About ### About
Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D as a Cloud Application Accelerator (CAA) project. Project Harbor is initiated by the Advanced Technology Center (ATC), VMware China R&D.

33
docs/README.md Normal file
View File

@ -0,0 +1,33 @@
## Table of Content
### User document
[Installation and Configuration Guide](installation_guide.md)
Read this first!
[Harbor User Guide](user_guide.md)
How to use Harbor to manage images, projects, replications and users.
[Configuring HTTPS for Harbor](configure_https.md)
Configure security connection between Harbor and Docker client.
[Upgrade and Data Migration Guide](migration_guide.md)
Data migration may be needed when upgrading Harbor to a newer version.
[Deploy Harbor on Kubernetes](kubernetes_deployment.md)
Guide to deploy Harbor on Kubenetes. (maintained by community)
### Developer document
[Arthicture Overview of Harbor](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor)
Developers read this first.
[Harbor API Specs by Swagger](configure_swagger.md)
Use Swagger to find out the specs of Harbor API.
[Internationalization Guide](developer_guide_i18n.md)
How to add your local language to Harbor.
[Python SDK](../contrib/sdk/harbor-py) (by community)
[Deploying Harbor using Docker Machine](../contrib/deploying_using_docker_machine.md) ( by community)
[Configuring Harbor as a local registry mirror](../contrib/Configure_mirror.md) (by community)