Installation and Configuration Guide
Harbor can be installed by one of three approaches:
- Online installer:
- Offline installer:
- OVA installer: Use this installer when user have a vCenter environment, Harbor is launched after OVA deployed. Detail information please refer Harbor OVA install guide
All installers can be downloaded from the official release
This guide describes the steps to install and configure Harbor by using the online or offline installer. The installation processes are almost the same.
If you run a previous version of Harbor, you may need to update
harbor.cfg
and migrate the data to fit the new database schema. For more details, please refer to Harbor Migration Guide.
In addition, the deployment instructions on Kubernetes has been created by the community. Refer to Harbor on Kubernetesfor details.
Prerequisites for the target host
Harbor is deployed as several Docker containers, and, therefore, can be deployed on any Linux distribution that supports Docker. The target host requires Python, Docker, and Docker Compose to be installed.
Hardware
Resource | Capacity | Description |
CPU | minimal 2 CPU | 4 CPU is prefered |
Mem | minimal 4GB | 8GB is prefered |
Disk | minimal 40GB | 160GB is prefered |
Software
Software | Version | Description |
Python | version 2.7 or higher | Note that you may have to install Python on Linux distributions (Gentoo, Arch) that do not come with a Python interpreter installed by default |
Docker engine | version 1.10 or higher | For installation instructions, please refer to: https://docs.docker.com/engine/installation/ |
Docker Compose | version 1.6.0 or higher | For installation instructions, please refer to: https://docs.docker.com/compose/install/ |
Openssl | latest is prefered | Generate certificate and keys for Harbor |
Network ports
Port | Protocol | Description |
443 | HTTPS | Harbor UI and API will accept requests on this port for https protocol |
4443 | HTTS | Connections to the Docker Content Trust service for Harbor, only needed when Notary is enabled |
80 | HTTP | Harbor UI and API will accept requests on this port for http protocol |
Installation Steps
The installation steps boil down to the following
- Download the installer;
- Configure harbor.cfg;
- Run install.sh
Downloading the installer:
The binary of the installer can be downloaded from the release page. Choose either online or offline installer. Use tarcommand to extract the package.
Online installer:
$ tar xvf harbor-online-installer-<version>.tgz
Offline installer:
$ tar xvf harbor-offline-installer-<version>.tgz
Configuring Harbor
Configuration parameters are located in the file harbor.cfg.
There are two categories of parameters in harbor.cfg, required parameters and optional parameters.
- required parameters: These parameters are required to be set in the configuration file. They will take effect if a user updates them in
harbor.cfg
- and run the
install.sh
- optional parameters: These parameters are optional for updating, i.e. user can leave them as default and update them on Web UI after Harbor is started. If they are set in
harbor.cfg
- , they only take effect in the first launch of Harbor. Subsequent update to these parameters in
harbor.cfg
- Note: If you choose to set these parameters via the UI, be sure to do so right after Harbor is started. In particular, you must set the desired auth_mode before registering or creating any new users in Harbor. When there are users in the system (besides the default admin user), auth_mode
The parameters are described below - note that at the very least, you will need to change the hostname
Required parameters:
- hostname: The target host's hostname, which is used to access the UI and the registry service. It should be the IP address or the fully qualified domain name (FQDN) of your target machine, e.g.,
192.168.1.10
- or
reg.yourdomain.com
- .
Do NOT use localhost or 127.0.0.1
- ui_url_protocol: (http or https. Default is http) The protocol used to access the UI and the token/notification service. If Notary is enabled, this parameter has to be https. By default, this is http. To set up the https protocol, refer to Configuring Harbor with HTTPS Access.
- db_password: The root password for the MySQL database used for db_auth. Change this password for any production use!
- max_job_workers: (default value is 3) The maximum number of replication workers in job service. For each image replication job, a worker synchronizes all tags of a repository to the remote destination. Increasing this number allows more concurrent replication jobs in the system. However, since each worker consumes a certain amount of network/CPU/IO resources, please carefully pick the value of this attribute based on the hardware resource of the host.
- customize_crt: (on or off. Default is on) When this attribute is on, the prepare script creates private key and root certificate for the generation/verification of the registry's token. Set this attribute to off when the key and root certificate are supplied by external sources. Refer to Customize Key and Certificate of Harbor Token Service for more info.
- ssl_cert: The path of SSL certificate, it's applied only when the protocol is set to https
- ssl_cert_key: The path of SSL key, it's applied only when the protocol is set to https
- secretkey_path: The path of key for encrypt or decrypt the password of a remote registry in a replication policy.
- log_rotate_count: Log files are rotated log_rotate_count
- log_rotate_size: Log files are rotated only if they grow bigger than log_rotate_size
Optional parameters
- Email settings: These parameters are needed for Harbor to be able to send a user a "password reset" email, and are only necessary if that functionality is needed. Also, do note that by default SSL connectivity is not enabled - if your SMTP server requires SSL, but does not support STARTTLS, then you should enable SSL by setting email_ssl = true. Setting email_insecure = true if the email server uses a self-signed or untrusted certificate. For a detailed description about "email_identity" please refer to rfc2595
- email_server = smtp.mydomain.com
- email_server_port = 25
- email_identity =
- email_username = [email protected]
- email_password = abc
- email_from = admin [email protected]
- email_ssl = false
- email_insecure = false
- harbor_admin_password: The administrator's initial password. This password only takes effect for the first time Harbor launches. After that, this setting is ignored and the administrator's password should be set in the UI. Note that the default username/password are admin/Harbor12345
-
auth_mode: The type of authentication that is used. By default, it is db_auth, i.e. the credentials are stored in a database. For LDAP authentication, set this to ldap_auth.
IMPORTANT: When upgrading from an existing Harbor instance, you must make sure auth_mode is the same in
harbor.cfg
- ldap_url: The LDAP endpoint URL (e.g.
ldaps://ldap.mydomain.com
- ). Only used when auth_mode is set to ldap_auth .
- ldap_searchdn: The DN of a user who has the permission to search an LDAP/AD server (e.g.
uid=admin,ou=people,dc=mydomain,dc=com
- ).
- ldap_search_pwd: The password of the user specified by ldap_searchdn.
- ldap_basedn: The base DN to look up a user, e.g.
ou=people,dc=mydomain,dc=com
- . Only used when auth_mode is set to ldap_auth .
- ldap_filter:The search filter for looking up a user, e.g.
(objectClass=person)
- .
- ldap_uid: The attribute used to match a user during a LDAP search, it could be uid, cn, email or other attributes.
- ldap_scope: The scope to search for a user, 0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE. Default is 2.
- self_registration: (on or off. Default is on) Enable / Disable the ability for a user to register himself/herself. When disabled, new users can only be created by the Admin user, only an admin user can create new users in Harbor. NOTE: When auth_mode is set to ldap_auth, self-registration feature is always
- token_expiration: The expiration time (in minutes) of a token created by token service, default is 30 minutes.
- project_creation_restriction: The flag to control what users have permission to create projects. By default everyone can create a project, set to "adminonly" such that only admin can create project.
Configuring storage backend (optional)
By default, Harbor stores images on your local filesystem. In a production environment, you may consider using other storage backend instead of the local filesystem, like S3, OpenStack Swift, Ceph, etc. What you need to update is the section of
storage
in the file
common/templates/registry/config.yml
. For example, if you use Openstack Swift as your storage backend, the section may look like this:
storage:
swift:
username: admin
password: ADMIN_PASS
authurl: http://keystone_addr:35357/v3/auth
tenant: admin
domain: default
region: regionOne
container: docker_images
NOTE: For detailed information on storage backend of a registry, refer to Registry Configuration Reference .
Finishing installation and starting Harbor
Once harbor.cfg and storage backend (optional) are configured, install and start Harbor using the
install.sh
Default installation (without Notary/Clair)
Harbor has integrated with Notary and Clair (for vulnerability scanning). However, the default installation does not include Notary or Clair service.
$ sudo ./install.sh
If everything worked properly, you should be able to open a browser to visit the admin portal at http://reg.yourdomain.com(change reg.yourdomain.com to the hostname configured in your
harbor.cfg
). Note that the default administrator username/password are admin/Harbor12345 .Log in to the admin portal and create a new project, e.g.
myproject
. You can then use docker commands to login and push images (By default, the registry server listens on port 80):
$ docker login reg.yourdomain.com
$ docker push reg.yourdomain.com/myproject/myrepo:mytag
IMPORTANT: The default installation of Harbor uses HTTP - as such, you will need to add the option
--insecure-registry
Installation with Notary
To install Harbor with Notary service, add a parameter when you run
install.sh
:
$ sudo ./install.sh --with-notary
Note: For installation with Notary the parameter ui_url_protocol
More information about Notary and Docker Content Trust, please refer to Docker's documentation:https://docs.docker.com/engine/security/trust/content_trust/
Installation with Clair
To install Harbor with Clair service, add a parameter when you run
install.sh
:
$ sudo ./install.sh --with-clair
For more information about Clair, please refer to Clair's documentation: https://coreos.com/clair/docs/2.0.1/
Note: If you want to install both Notary and Clair, you must specify both parameters in the same command:
$ sudo ./install.sh --with-notary --with-clair
For information on how to use Harbor, please refer to User Guide of Harbor
Configuring Harbor with HTTPS access
Harbor does not ship with any certificates, and, by default, uses HTTP to serve requests. While this makes it relatively simple to set up and run - especially for a development or testing environment - it is not recommended for a production environment. To enable HTTPS, please refer to Configuring Harbor with HTTPS Access.
Managing Harbor's lifecycle
You can use docker-compose to manage the lifecycle of Harbor. Some useful commands are listed as follows (must run in the same directory as docker-compose.yml).
Stopping Harbor:
$ sudo docker-compose stop
Stopping nginx ... done
Stopping harbor-jobservice ... done
Stopping harbor-ui ... done
Stopping harbor-db ... done
Stopping registry ... done
Stopping harbor-log ... done
Restarting Harbor after stopping:
$ sudo docker-compose start
Starting log ... done
Starting ui ... done
Starting mysql ... done
Starting jobservice ... done
Starting registry ... done
Starting proxy ... done
To change Harbor's configuration, first stop existing Harbor instance and update
harbor.cfg
. Then run
prepare
$ sudo docker-compose down -v
$ vim harbor.cfg
$ sudo prepare
$ sudo docker-compose up -d
Removing Harbor's containers while keeping the image data and Harbor's database files on the file system:
$ sudo docker-compose down -v
Removing Harbor's database and image data (for a clean re-installation):
$ rm -r /data/database
$ rm -r /data/registry
Managing lifecycle of Harbor when it's installed with Notary
When Harbor is installed with Notary, an extra template file
docker-compose.notary.yml
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml [ up|down|ps|stop|start ]
For example, if you want to change configuration in
harbor.cfg
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml down -v
$ vim harbor.cfg
$ sudo prepare --with-notary
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml up -d
Managing lifecycle of Harbor when it's installed with Clair
When Harbor is installed with Clair, an extra template file
docker-compose.clair.yml
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml [ up|down|ps|stop|start ]
For example, if you want to change configuration in
harbor.cfg
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml down -v
$ vim harbor.cfg
$ sudo prepare --with-clair
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.clair.yml up -d
Managing lifecycle of Harbor when it's installed with Notary and Clair
If you have installed Notary and Clair, you should include both components in the docker-compose and prepare commands:
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml -f ./docker-compose.clair.yml down -v
$ vim harbor.cfg
$ sudo prepare --with-notary --with-clair
$ sudo docker-compose -f ./docker-compose.yml -f ./docker-compose.notary.yml -f ./docker-compose.clair.yml up -d
Please check the Docker Compose command-line reference for more on docker-compose.
Persistent data and log files
By default, registry data is persisted in the host's
/data/
In addition, Harbor uses rsyslog to collect the logs of each container. By default, these log files are stored in the directory
/var/log/harbor/
Configuring Harbor listening on a customized port
By default, Harbor listens on port 80(HTTP) and 443(HTTPS, if configured) for both admin portal and docker commands, you can configure it with a customized one.
For HTTP protocol
1.Modify docker-compose.yml
Replace the first "80" to a customized port, e.g. 8888:80.
proxy:
image: library/nginx:1.11.5
restart: always
volumes:
- ./config/nginx:/etc/nginx
ports:
- 8888:80
- 443:443
depends_on:
- mysql
- registry
- ui
- log
logging:
driver: "syslog"
options:
syslog-address: "tcp://127.0.0.1:1514"
tag: "proxy"
2.Modify harbor.cfg, add the port to the parameter "hostname"
hostname = 192.168.0.2:8888
3.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle".
For HTTPS protocol
1.Enable HTTPS in Harbor by following this guide.
2.Modify docker-compose.yml
Replace the first "443" to a customized port, e.g. 8888:443.
proxy:
image: library/nginx:1.11.5
restart: always
volumes:
- ./config/nginx:/etc/nginx
ports:
- 80:80
- 8888:443
depends_on:
- mysql
- registry
- ui
- log
logging:
driver: "syslog"
options:
syslog-address: "tcp://127.0.0.1:1514"
tag: "proxy"
3.Modify harbor.cfg, add the port to the parameter "hostname"
hostname = 192.168.0.2:8888
4.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle".
Performance tuning
Troubleshooting
- When Harbor does not work properly, run the below commands to find out if all containers of Harbor are in UP
$ sudo docker-compose ps
Name Command State Ports
-----------------------------------------------------------------------------------------------------
harbor-db docker-entrypoint.sh mysqld Up 3306/tcp
harbor-jobservice /harbor/harbor_jobservice Up
harbor-log /bin/sh -c crond && rsyslo ... Up 127.0.0.1:1514->514/tcp
harbor-ui /harbor/harbor_ui Up
nginx nginx -g daemon off; Up 0.0.0.0:443->443/tcp, 0.0.0.0:80->80/tcp
registry /entrypoint.sh serve /etc/ ... Up 5000/tcp
proxy_set_header X-Forwarded-Proto $scheme;