diff --git a/docs/installation_guide.md b/docs/installation_guide.md index b61f093ca..e40c54b17 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -230,6 +230,27 @@ The following table lists the additional parameters that you can set to configu Enable this option to use an external proxy. When enabled, the hostname is no longer used. + + storage_service +   + By default, Harbor stores images and charts on your local filesystem. In a production environment, you may consider use other storage backend instead of the local filesystem, like S3, OpenStack Swift, Ceph, etc. These parameters are configurations for registry. See *Configuring Storage Backend* below for more information. + + +   + ca_bundle + The path to the custom root ca certificate, which will be injected into the trust store of registry's and chart repository's containers. This is usually needed when the user hosts a internal storage with self signed certificate. + + +   + provider_name + Storage configs for registry, default is filesystem. for more info about this configuration please refer https://docs.docker.com/registry/configuration/ + + +   + redirect + disable: set disable to true when you want to disable registry redirect + + clair   Configure clair. @@ -239,20 +260,15 @@ The following table lists the additional parameters that you can set to configu updaters_interval Set an interval for Clair updates, in hours. Set to 0 to disable the updates. - -   - http_proxy - Configure an HTTP proxy for Clair, for example, http://my.proxy.com:3128. + + notification + webhook_job_max_retry + Set the maximum number of retries for web hook jobs. The default is 10.   - https_proxy - Configure an HTTPS proxy for Clair, for example, http://my.proxy.com:3128. - - -   - no_proxy - Configure when not to use a proxy for Clair, for example, 127.0.0.1,localhost,core,registry. + updaters_interval + Set an interval for Clair updates, in hours. Set to 0 to disable the updates. chart @@ -264,7 +280,6 @@ The following table lists the additional parameters that you can set to configu absolute_url Set to enabled for chart to use an absolute URL. Set to disabled for chart to use a relative URL. - external_database   Configure external database settings, if you disable the local database option. Harbor currently only supports POSTGRES. @@ -358,24 +373,34 @@ The following table lists the additional parameters that you can set to configu db index for chartmuseum - storage_service + uaa   - By default, Harbor stores images and charts on your local filesystem. In a production environment, you may consider use other storage backend instead of the local filesystem, like S3, OpenStack Swift, Ceph, etc. These parameters are configurations for registry. See *Configuring Storage Backend* below for more information. + Enable UAA to trust the certificate of a UAA instance that is hosted via a self-signed certificate.   - ca_bundle - The path to the custom root ca certificate, which will be injected into the trust store of registry's and chart repository's containers. This is usually needed when the user hosts a internal storage with self signed certificate. + ca_file + The path to the self-signed certificate of the UAA instance, for example /path/to/ca. + + + proxy +   + Configure proxies to be used by Clair, the replication jobservice, and Harbor. + + +   + http_proxy + Configure an HTTP proxy, for example, http://my.proxy.com:3128.   - provider_name - Storage configs for registry, default is filesystem. for more info about this configuration please refer https://docs.docker.com/registry/configuration/ + https_proxy + Configure an HTTPS proxy, for example, http://my.proxy.com:3128.   - redirect - disable: set disable to true when you want to disable registry redirect + no_proxy + Configure when not to use a proxy, for example, 127.0.0.1,localhost,core,registry.