harbor README

The project's README from github.com/goharbor/harbor. As one markdown file: README.md.

Harbor

CI Go Report Card Coverage Status CII Best Practices Codacy Badge Code scanning - action OCI Distribution Conformance Tests FOSSA Status Helm Chart on Artifact Hub OpenSSF Scorecard

notificationCommunity Meeting
The Harbor Project holds bi-weekly community calls in two different timezones. To join the community calls or to watch previous meeting notes and recordings, please visit the meeting schedule.



Note: The main branch may be in an unstable or even broken state during development. Please use releases instead of the main branch in order to get a stable set of binaries.

Harbor

Harbor is an open source trusted cloud native registry project that stores, signs, and scans content. Harbor extends the open source Docker Distribution by adding the functionalities usually required by users such as security, identity and management. Having a registry closer to the build and run environment can improve the image transfer efficiency. Harbor supports replication of images between registries, and also offers advanced security features such as user management, access control and activity auditing.

Harbor is hosted by the Cloud Native Computing Foundation (CNCF). If you are an organization that wants to help shape the evolution of cloud native technologies, consider joining the CNCF. For details about who is involved and how Harbor plays a role, read the CNCF announcement.

Features

Architecture

For learning the architecture design of Harbor, check the document Architecture Overview of Harbor.

API

Install & Run

System requirements:

On a Linux host: docker 20.10.10-ce+ and docker-compose 1.18.0+.

Download binaries of Harbor release and follow Installation & Configuration Guide to install Harbor.

If you want to deploy Harbor on Kubernetes, please use the Harbor chart.

Refer to the documentation for more details on how to use Harbor.

Verifying Release Signatures

Starting with v2.15.0, Harbor release artifacts are cryptographically signed using Cosign to ensure authenticity and integrity.

Download the installers and signature bundles from the Harbor releases page.

Quick Verification

# Install Cosign (v2.0+)
brew install sigstore/tap/cosign

# Verify signature
cosign verify-blob \
  --bundle harbor-offline-installer-v2.15.0.tgz.sigstore.json \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  --certificate-identity-regexp '^https://github.com/goharbor/harbor/.github/workflows/publish_release.yml@refs/tags/v.*$' \
  harbor-offline-installer-v2.15.0.tgz

OCI Distribution Conformance Tests

Check the OCI distribution conformance tests report of Harbor.

Compatibility

The compatibility list document provides compatibility information for the Harbor components.

Community

Demos

Partners and Users

For a list of users, please refer to ADOPTERS.md.

Security

Security Audit

A third party security audit was performed by Cure53 in October 2019. You can see the full report here.

Reporting security vulnerabilities

If you've found a security related issue, a vulnerability, or a potential vulnerability in Harbor, do not file a public issue. Report it privately via GitHub private vulnerability reporting: open the Security tab and click Report a vulnerability. The Harbor Security Team will acknowledge your report, and will follow up in the advisory thread once we've identified the issue positively or negatively.

For further details please see our complete security release process.

License

Harbor is available under the Apache 2 license.

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:

Fossa Status

FOSSA Status

harbor (goharbor/harbor)

Searching Database…

29.6K ·GitHub
Harbor
What is this?Harbor is an open source trusted cloud native registry that stores, signs, and scans content — mainly container images and Helm charts. It is a CNCF-hosted project.
Why would I run my own registry instead of just using Docker Hub?It is a registry you self-host: Harbor extends the open source Docker Distribution with security, identity and management. Running it close to your build and run environment also improves image transfer efficiency.
How do I get it running?Download the binaries of a Harbor release and follow the Installation & Configuration Guide. For Kubernetes use the Harbor chart; Docker Compose and a Harbor Operator are supported too.
What does the host machine need?A Linux host with Docker 20.10.10-ce or newer and docker-compose 1.18.0 or newer.
Can I just use the main branch, or do I need a release?Use releases — the main branch may be unstable or even broken during development, so it is not a source of stable binaries.
Does it store anything besides container images?Yes — Harbor also serves as a registry for Helm charts, and the same project-based access control covers charts as well as images.
Can I try it online before installing?Yes — the README links a live demo environment with the latest stable Harbor build, plus continuously updated video demos of its features.
Has the code ever been independently audited?Yes — Cure53 performed a third-party security audit of Harbor in October 2019, and the full report is linked from the README.
How do I know a downloaded release is authentic?Since v2.15.0, Harbor release artifacts are cryptographically signed with Cosign — download the signature bundle from the releases page; a successful check prints 'Verified OK'.
What are similar projects?distribution, containerd, ingress-nginx, apowerb, charts, helm, AgentTeams, slim
Which topics is it in?helm-charts, container, devops-tools, helm, registry, cncf, containers, cloud-native, enterprise, authentication, kubernetes, docker-compose
Creator
goharbor
Size
261.1 MB
Stars
29.6K
Updated
CommitOct 16Releasev2.15.4Oct 09
Age
10y
Commits · 90 Days