website/docs

Harbor Documentation

This is the main table of contents for the Harbor 2.1.x documentation.

Harbor Installation and Configuration

This section describes how to install Harbor and perform the required initial configurations. These day 1 operations are performed by the Harbor Administrator.

• Introduction
• Test Harbor with the Demo Server
• Harbor Compatibility List
• Harbor Installation Prerequisites
• Download the Harbor Installer
• Configure HTTPS Access to Harbor
• Configure the Harbor YML File
• Run the Installer Script
• Deploying Harbor with High Availability via Helm
• Troubleshooting Harbor Installation
• Reconfigure Harbor and Manage the Harbor Lifecycle
• Customize the Harbor Token Service
• Configure Harbor Settings at the Command Line

Harbor Administration

This section describes how to use and maintain Harbor after deployment. These day 2 operations are performed by the Harbor Administrator.

• Introduction
• Configuring Authentication
  • Configure Database Authentication
  • Configure LDAP/Active Directory Authentication
  • Configure OIDC Provider Authentication
• Managing Users
  • User Permissions By Role
  • Create User Accounts in Database Mode
• Configure Global Settings
• Configure Project Quotas
• Configuring Replication
  • Create Replication Endpoints
  • Create Replication Rules
  • Manage Replications
• Vulnerability Scanning
  • Connect Harbor to Additional Vulnerability Scanners
  • Scan Individual Images
  • Scan All Images
  • Schedule Scans
  • Import Vulnerability Data to an Offline Harbor instance
  • Configure System-Wide CVE Allowlists
• Garbage Collection
• Upgrade Harbor and Migrate Data
  • Upgrading Harbor Deployed with Helm
  • Roll Back an Upgrade
  • Test Harbor Upgrade
• Configure P2P Preheat
• User-defined OCI artifact

Working with Harbor Projects

This section describes how users with the developer, maintainer, and project administrator roles manage and participate in Harbor projects.

• Introduction
• Create Projects
  • Assign Users to a Project
• Project Configuration
  • Access and Search Project Logs
  • Create Robot Accounts
  • Configure Webhook Notifications
  • Configure a Per-Project CVE Allowlist
  • Implementing Content Trust
• Working with Images, Tags, and Helm Charts
  • Pulling and Pushing Images
  • Create Labels
  • Retag Images
  • Create Tag Retention Rules
  • Create Tag Immutability Rules
  • Manage Kubernetes Packages with Helm Charts
  • Preheat Images
• Using API Explorer

Build, Customize, and Contribute to Harbor

This section describes how developers can build from Harbor source code, customize their deployments, and contribute to the open-source Harbor project.

• Build Harbor from Source Code
• Developing the Harbor Frontend
• Customize the Harbor Look & Feel
• Developing for Internationalization
• Using Make
• View and test Harbor REST API via Swagger
• Registry Landscape
• E2E Test Scripting Guide

See also the list of Articles from the Harbor Community.