harbor/docs/README.md

71 lines
3.1 KiB
Markdown
Raw Normal View History

2016-09-13 12:21:21 +02:00
## Table of Content
2016-09-16 16:04:36 +02:00
### User documents
2016-11-01 16:45:47 +01:00
**[Installation and Configuration Guide](installation_guide.md)
Read this first!**
Guide for Harbor online installer and offline installer.
2016-09-13 12:21:21 +02:00
2016-11-01 16:45:47 +01:00
**[Installation and Configuration Guide for Virtual Appliance](installation_guide_ova.md)**
Guide for installing Harbor on vSphere, either standalone or as part of vSphere Integrated Containers (VIC).
**[Harbor User Guide](user_guide.md)**
2016-09-13 12:21:21 +02:00
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.
2016-11-01 16:45:47 +01:00
[Deploy Harbor on Kubernetes](kubernetes_deployment.md)
2016-09-13 12:21:21 +02:00
Guide to deploy Harbor on Kubenetes. (maintained by community)
2016-09-16 16:04:36 +02:00
### Developer documents
2016-12-08 11:22:00 +01:00
[Architecture Overview of Harbor](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor)
2016-09-13 12:21:21 +02:00
Developers read this first.
2017-01-23 15:08:41 +01:00
[Build Harbor from Source](compile_guide.md)
How to build Harbor from source code.
2016-09-13 12:21:21 +02:00
[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)
2016-11-01 16:50:59 +01:00
[Harbor CLI](https://github.com/int32bit/harborclient) (by community)
[Deploy Harbor using Docker Machine](../contrib/deploying_using_docker_machine.md) ( by community)
2016-09-13 12:21:21 +02:00
[Configuring Harbor as a local registry mirror](../contrib/Configure_mirror.md) (by community)
2016-09-16 16:04:36 +02:00
### Articles from the community
[Remote site replicated Docker Registries with VMware Harbor](http://www.vmtocloud.com/remote-site-replicated-docker-registries-with-vmware-harbor/)
[Hybrid cloud Docker Registry with VMware Harbor](http://www.vmtocloud.com/hybrid-cloud-docker-registry-with-vmware-harbor/)
[Harbor Registry Blueprint for vRA](http://www.vmtocloud.com/harbor-registry-blueprint-is-here/)
2016-11-01 16:45:47 +01:00
[Architecture of Harbor: An Open Source Enterprise-class Registry Server](http://www.think-foundry.com/architecture-of-harbor-an-open-source-enterprise-class-registry-server/)
[Private Harbor Registry Achieves High Availability based on Virtual SAN](http://www.think-foundry.com/private-docker-registry-harbor-achieves-ha-based-on-virtual-san/)
[Working with Harbor Registry REST API via Swagger](http://www.think-foundry.com/working-with-harbor-registry-rest-api-via-swagger/)
2016-09-16 16:04:36 +02:00
[Project Harbor in action](http://cormachogan.com/2016/08/05/project-harbor-action/)
[Using vSphere docker volume driver to run Project Harbor on VSAN](http://cormachogan.com/2016/07/29/using-vsphere-docker-volume-driver-run-project-harbor-vsan/)
[Overall Architecture of Harbor Registry](http://www.compare-review-information.com/overall-architecture-of-harbor-registry/)
2016-12-08 11:22:00 +01:00
[Making a Private Secured Docker Registry in 15 Minutes](http://alexanderzeitler.com/articles/deploying-a-private-secured-docker-registry-within-15-minutes/)
2016-09-16 16:04:36 +02:00
[Docker Private Registry Using Harbor](https://blog.imaginea.com/docker-private-registry-using-harbor-2/)