diff --git a/docs/harbor-doc-reorg/_index.md b/docs/harbor-doc-reorg/_index.md index a1aa9b5fe..4c42a42ec 100644 --- a/docs/harbor-doc-reorg/_index.md +++ b/docs/harbor-doc-reorg/_index.md @@ -11,18 +11,18 @@ This section describes how to install Harbor and perform the required initial co - [Test Harbor with the Demo Server](install_config/installation/demo_server.md) - [Harbor Compatibility List](install_config/installation/harbor_compatibility_list.md) - [Harbor Installation Prerequisites](install_config/installation/installation_prereqs.md) - - **[Configure HTTPS Access to Harbor](install_config/installation/configure_https.md)** - [Download the Harbor Installer](install_config/installation/download_installer.md) - - **[Configure the Harbor YML File](install_config/installation/configure_yml_file.md)** + - [Configure HTTPS Access to Harbor](install_config/installation/configure_https.md) + - [Configure the Harbor YML File](install_config/installation/configure_yml_file.md) - [Run the Installer Script](install_config/installation/run_installer_script.md) - - **[Troubleshooting Harbor Installation](install_config/installation/troubleshoot_installation.md)** + - [Troubleshooting Harbor Installation](install_config/installation/troubleshoot_installation.md) - [Post-Installation Configuration](install_config/configuration/_index.md) - - **[Reconfigure Harbor and Manage the Harbor Lifecycle](install_config/configuration/reconfigure_manage_lifecycle.md)** - - **[Customize the Harbor Token Service](install_config/configuration/customize_token_service.md)** - - **[Configure Notary Content Trust](install_config/configuration/configure_notary_content_trust.md)** + - [Reconfigure Harbor and Manage the Harbor Lifecycle](install_config/configuration/reconfigure_manage_lifecycle.md) + - [Customize the Harbor Token Service](install_config/configuration/customize_token_service.md) + - [Configure Notary Content Trust](install_config/configuration/configure_notary_content_trust.md) - [Initial Configuration in the Harbor UI](install_config/configuration/initial_config_ui.md) - [Configure Authentication](install_config/configuration/configure_authentication.md) - - **[Administrator Options](install_config/configuration/general_settings.md)** + - [Administrator Options](install_config/configuration/general_settings.md) ## Harbor Administration @@ -30,9 +30,9 @@ This section describes how to use and maintain Harbor after deployment. These da - [Harbor Administration](administration/_index.md) - [Manage Users](administration/managing_users/_index.md) - - **[Harbor Role Based Access Control (RBAC)](administration/managing_users/configure_rbac.md)** + - [Harbor Role Based Access Control (RBAC)](administration/managing_users/configure_rbac.md) - [User Permissions By Role](administration/managing_users/user_permissions_by_role.md) - - **[Configure Harbor User Settings at the Command Line](administration/managing_users/configure_user_settings_cli.md)** + - [Configure Harbor User Settings at the Command Line](administration/managing_users/configure_user_settings_cli.md) - [Configure Project Settings](administration/configure_project_settings/_index.md) - [Set Project Quotas](administration/configure_project_settings/set_project_quotas.md) - [Configuring Replication](administration/configuring_replication/_index.md) @@ -62,15 +62,15 @@ This section describes how users with the developer, master, and project adminis - [Create a Project](working_with_projects/create_projects.md) - [Assign Users to a Project](working_with_projects/add_users.md) - [Project Configuration](working_with_projects/project_configuration.md) - - **[Access and Search Project Logs](working_with_projects/access_project_logs.md)** + - [Access and Search Project Logs](working_with_projects/access_project_logs.md) - [Create Robot Accounts](working_with_projects/create_robot_accounts.md) - [Configure Webhook Notifications](working_with_projects/configure_webhooks.md) - [Configure a Per-Project CVE Whitelist](working_with_projects/configure_project_whitelist.md) - - **[Implementing Content Trust](working_with_projects/implementing_content_trust.md)** + - [Implementing Content Trust](working_with_projects/implementing_content_trust.md) - [Working with Images, Tags, and Helm Charts](working_with_projects/working_with_images.md) - [Pulling and Pushing Images](working_with_projects/pulling_pushing_images.md) - - **[Create Labels](working_with_projects/create_labels.md)** - - **[Retag Images](working_with_projects/retagging_images.md) ** + - [Create Labels](working_with_projects/create_labels.md) + - [Retag Images](working_with_projects/retagging_images.md) ** - [Create Tag Retention Rules](working_with_projects/create_tag_retention_rules.md) - [Create Tag Immutability Rules](working_with_projects/create_tag_immutability_rules.md) - [Manage Kubernetes Packages with Helm Charts](working_with_projects/managing_helm_charts.md) diff --git a/docs/harbor-doc-reorg/install_config/_index.md b/docs/harbor-doc-reorg/install_config/_index.md index 2bf61a548..bf60d15fe 100644 --- a/docs/harbor-doc-reorg/install_config/_index.md +++ b/docs/harbor-doc-reorg/install_config/_index.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Harbor Installation and Configuration This document describes how to install Harbor, and how to perform initial configuration. diff --git a/docs/harbor-doc-reorg/install_config/installation/_index.md b/docs/harbor-doc-reorg/install_config/installation/_index.md index 76d3e3311..df966b6ef 100644 --- a/docs/harbor-doc-reorg/install_config/installation/_index.md +++ b/docs/harbor-doc-reorg/install_config/installation/_index.md @@ -1,8 +1,10 @@ -Back to table of contents +[Back to table of contents](../_index.md) + +---------- # Installing Harbor -This guide describes how to install for the first time. +This section describes how to install for the first time. If you are upgrading from a previous version of Harbor, you might need to update the configuration file and migrate your data to fit the database schema of the later version. For information about upgrading, see the [Upgrading Harbor](../../administration/upgrade/_index.md). @@ -10,11 +12,15 @@ You can also use Helm to install Harbor on a Kubernetes cluster, to make it high Before you install Harbor, you can test its functionality on a demo server that the Harbor team has made available. For information, see [Test Harbor with the Demo Server](demo_server.md). +You can use Harbor with different 3rd party replication adapters, OIDC adapters, and scanner adapters. For information about the supported adapters, see the [Harbor Compatibility List](harbor_compatibility_list.md). + +## Installation Process + The standard Harbor installation process involves the following stages: 1. Make sure that your target host meets the [Harbor Installation Prerequisites](installation_prereqs.md). -1. [Configure HTTPS Access to Harbor](configure_https.md) 1. [Download the Harbor Installer](download_installer.md) +1. [Configure HTTPS Access to Harbor](configure_https.md) 1. [Configure the Harbor YML File](configure_yml_file.md) 1. [Run the Installer Script](run_installer_script.md) @@ -37,4 +43,5 @@ The table below lists the components that are deployed when you deploy Harbor. |Helm|2.9.1| |Swagger-ui|3.22.1| -Back to table of contents \ No newline at end of file +---------- +[Back to table of contents](../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/configure_https.md b/docs/harbor-doc-reorg/install_config/installation/configure_https.md index d75d59801..f43794c56 100644 --- a/docs/harbor-doc-reorg/install_config/installation/configure_https.md +++ b/docs/harbor-doc-reorg/install_config/installation/configure_https.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Configure HTTPS Access to Harbor By default, Harbor does not ship with certificates. It is possible to deploy Harbor without security, so that you can connect to it over HTTP. However, using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks. In production environments, always use HTTPS. If you enable Content Trust with Notary to properly sign all images, you must use HTTPS. @@ -199,4 +201,6 @@ If you've mapped nginx 443 port to another, you need to add the port to login, l To start the installation process, [Download the Harbor Installer](download_installer.md). +---------- + [Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md b/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md index d28e47e29..5425eea7d 100644 --- a/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md +++ b/docs/harbor-doc-reorg/install_config/installation/configure_yml_file.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Configure the Harbor YML File You set system level parameters for Harbor in the `harbor.yml` file that is contained in the installer package. These parameters take effect when you run the `install.sh` script to install or reconfigure Harbor. @@ -334,4 +336,6 @@ Currently, Harbor only supports PostgreSQL database. To use an external database To install Harbor, [Run the Installer Script](run_installer_script.md). +---------- + [Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/installation/demo_server.md b/docs/harbor-doc-reorg/install_config/installation/demo_server.md index 4ab7aab8a..7e5185903 100644 --- a/docs/harbor-doc-reorg/install_config/installation/demo_server.md +++ b/docs/harbor-doc-reorg/install_config/installation/demo_server.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Test Harbor with the Demo Server The Harbor team has made available a demo Harbor instance that you can use to experiment with Harbor and test its functionalities. @@ -51,8 +53,7 @@ If you encounter any problems while using the demo server, open an [issue on Git ## What to Do Next ## -If you decide to install Harbor, verify that your target host meets the [Harbor Installation Prerequisites](installation_prereqs.md). - +See the [Harbor Installation Prerequisites](installation_prereqs.md). ---------- diff --git a/docs/harbor-doc-reorg/install_config/installation/download_installer.md b/docs/harbor-doc-reorg/install_config/installation/download_installer.md index 1ce7a4622..379ab4e2e 100644 --- a/docs/harbor-doc-reorg/install_config/installation/download_installer.md +++ b/docs/harbor-doc-reorg/install_config/installation/download_installer.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Download the Harbor Installer: You download the installers from the **[official releases](https://github.com/goharbor/harbor/releases)** page. Choose either the online or the offline installer. diff --git a/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md b/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md index 7ba38f9a3..5239e3b8f 100644 --- a/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md +++ b/docs/harbor-doc-reorg/install_config/installation/installation_prereqs.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Harbor Installation Prerequisites Harbor is deployed as several Docker containers. You can therefore deploy it on any Linux distribution that supports Docker. The target host requires Docker, and Docker Compose to be installed. @@ -20,9 +22,9 @@ The following table lists the software versions that must be installed on the ta |Software|Version|Description| |---|---|---| -|Docker engine|version 17.06.0-ce+ or higher|For installation instructions, see [docker engine doc](https://docs.docker.com/engine/installation/)| -|Docker Compose|version 1.18.0 or higher|For installation instructions, see [docker compose doc](https://docs.docker.com/compose/install/)| -|Openssl|latest is preferred|Used to generate certificate and keys for Harbor| +|Docker engine|Version 17.06.0-ce+ or higher|For installation instructions, see [docker engine doc](https://docs.docker.com/engine/installation/)| +|Docker Compose|Version 1.18.0 or higher|For installation instructions, see [docker compose doc](https://docs.docker.com/compose/install/)| +|Openssl|Latest is preferred|Used to generate certificate and keys for Harbor| ### Network ports diff --git a/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md b/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md index 6d78b64c0..12669d0ce 100644 --- a/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md +++ b/docs/harbor-doc-reorg/install_config/installation/run_installer_script.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Run the Installer Script Once you have configured **harbor.yml** and optionally set up a storage backend, you install and start Harbor by using the `install.sh` script. Note that it might take some time for the online installer to download all of the Harbor images from Docker hub. diff --git a/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md b/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md index cf35de840..5a47de395 100644 --- a/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md +++ b/docs/harbor-doc-reorg/install_config/installation/troubleshoot_installation.md @@ -1,5 +1,7 @@ [Back to table of contents](../../_index.md) +---------- + # Troubleshooting Harbor Installation ## Harbor Doesn't Start or Functions Incorrectly