Rewrites in install topic

This commit is contained in:
Stuart Clements 2019-12-18 14:38:17 +01:00
parent af24c0a656
commit 42e2147935
2 changed files with 25 additions and 21 deletions

View File

@ -38,7 +38,7 @@ You can use certificates that are signed by a trusted third-party CA, or you can
<tr> <tr>
<td valign="top">&nbsp;</td> <td valign="top">&nbsp;</td>
<td valign="top"><code>port</code></td> <td valign="top"><code>port</code></td>
<td valign="top">Port number for HTTP, for both Harbor portal and Docker commands.</td> <td valign="top">Port number for HTTP, for both Harbor portal and Docker commands. The default is 80.</td>
</tr> </tr>
<tr> <tr>
<td valign="top"><code>https</code></td> <td valign="top"><code>https</code></td>
@ -49,7 +49,7 @@ You can use certificates that are signed by a trusted third-party CA, or you can
<tr> <tr>
<td valign="top">&nbsp;</td> <td valign="top">&nbsp;</td>
<td valign="top"><code>port</code></td> <td valign="top"><code>port</code></td>
<td valign="top">The port number for HTTPS, for both Harbor portal and Docker commands.</td> <td valign="top">The port number for HTTPS, for both Harbor portal and Docker commands. The default is 443.</td>
</tr> </tr>
<tr> <tr>
<td valign="top">&nbsp;</td> <td valign="top">&nbsp;</td>

View File

@ -4,7 +4,7 @@
# Run the Installer Script # 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. 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.
You can install Harbor in different configurations: You can install Harbor in different configurations:
@ -16,32 +16,36 @@ You can install Harbor in different configurations:
## Default installation without Notary, Clair, or Chart Repository Service ## Default installation without Notary, Clair, or Chart Repository Service
The default Harbor installation does not include Notary or Clair service. The default Harbor installation does not include Notary or Clair service. Run the following command
``` sh ```
$ sudo ./install.sh sudo ./install.sh
``` ```
If the installation succeeds, you can open a browser to visit the Harbor Portal at `http://reg.yourdomain.com`, changing `reg.yourdomain.com` to the hostname that you configured in `harbor.yml`. If you did not change them, the default administrator username and password are `admin` and `Harbor12345`. If the installation succeeds, you can open a browser to visit the Harbor interface at `http://reg.yourdomain.com`, changing `reg.yourdomain.com` to the hostname that you configured in `harbor.yml`. If you did not change them in `harbor.yml`, the default administrator username and password are `admin` and `Harbor12345`.
Log in to the admin portal and create a new project, for example, `myproject`. You can then use docker commands to log in and push images to Harbor. By default, the registry server listens on port 80: Log in to the admin portal and create a new project, for example, `myproject`. You can then use Docker commands to log in to Harbor, tag images, and push them to Harbor.
```sh ```
$ docker login reg.yourdomain.com docker login reg.yourdomain.com
$ docker push reg.yourdomain.com/myproject/myrepo:mytag ```
```
docker push reg.yourdomain.com/myproject/myrepo:mytag
``` ```
**IMPORTANT:** If your installation of Harbor uses HTTP, you must add the option `--insecure-registry` to your client's Docker daemon and restart the Docker service. For more information, see [Connecting to Harbor via HTTP](#connect_http) below. **IMPORTANT:**
- If your installation of Harbor uses HTTPS, you must provide the Harbor certificates to the Docker client. For information, see [Configure HTTPS Access to Harbor](configure_https.md#provide-the-certificates-to-harbor-and-docker).
- If your installation of Harbor uses HTTP, you must add the option `--insecure-registry` to your client's Docker daemon and restart the Docker service. For more information, see [Connecting to Harbor via HTTP](#connect_http) below.
## Installation with Notary ## Installation with Notary
To install Harbor with the Notary service, add the `--with-notary` parameter when you run `install.sh`: To install Harbor with the Notary service, add the `--with-notary` parameter when you run `install.sh`:
```sh ```
$ sudo ./install.sh --with-notary sudo ./install.sh --with-notary
``` ```
**Note**: For installation with Notary, you must use Harbor with HTTPS. **NOTE**: For installation with Notary, you must configure Harbor to use HTTPS.
For more information about Notary and Docker Content Trust, see [Content Trust](https://docs.docker.com/engine/security/trust/content_trust/) in the Docker documentation. For more information about Notary and Docker Content Trust, see [Content Trust](https://docs.docker.com/engine/security/trust/content_trust/) in the Docker documentation.
@ -49,8 +53,8 @@ For more information about Notary and Docker Content Trust, see [Content Trust](
To install Harbor with Clair service, add the `--with-clair` parameter when you run `install.sh`: To install Harbor with Clair service, add the `--with-clair` parameter when you run `install.sh`:
```sh ```
$ sudo ./install.sh --with-clair sudo ./install.sh --with-clair
``` ```
For more information about Clair, see the [Clair documentation](https://coreos.com/clair/docs/2.0.1/). For more information about Clair, see the [Clair documentation](https://coreos.com/clair/docs/2.0.1/).
@ -59,17 +63,17 @@ By default, Harbor limits the CPU usage of the Clair container to 150000 to avoi
## Installation with Chart Repository Service ## Installation with Chart Repository Service
To install Harbor with chart repository service, add the `--with-chartmuseum` parameter when you run ```install.sh```: To install Harbor with chart repository service, add the `--with-chartmuseum` parameter when you run `install.sh`:
```sh ```
$ sudo ./install.sh --with-chartmuseum $ sudo ./install.sh --with-chartmuseum
``` ```
## Installation with Notary, Clair, and Chart Repository Service ## Installation with Notary, Clair, and Chart Repository Service
If you want to install all three of Notary, Clair and chart repository service, you must specify all of the parameters in the same command: If you want to install all three of Notary, Clair and chart repository service, specify all of the parameters in the same command:
```sh ```
$ sudo ./install.sh --with-notary --with-clair --with-chartmuseum $ sudo ./install.sh --with-notary --with-clair --with-chartmuseum
``` ```