diff --git a/contrib/deploying_using_docker_machine.md b/contrib/deploying_using_docker_machine.md index a0594168f..cdd93d8a7 100644 --- a/contrib/deploying_using_docker_machine.md +++ b/contrib/deploying_using_docker_machine.md @@ -16,7 +16,7 @@ You can get this IP address using: $ docker-machine ip harbor.mydomain.com ``` -Make sure to change the `hostname` in `Deploy/harbor.yml` to `harbor.mydomain.com`, configure everything else according to the [Harbor Installation Guide](../docs/installation_guide.md) and run `prepare`. +Copy `Deploy/harbor.yml.tmp` to `Deploy/harbor.yml` and make sure to change the `hostname` in `Deploy/harbor.yml` to `harbor.mydomain.com`, configure everything else according to the [Harbor Installation Guide](../docs/installation_guide.md) and run `prepare`. Now, activate the created Docker Machine instance: diff --git a/docs/administration/upgrade/_index.md b/docs/administration/upgrade/_index.md index 0f63379a3..de833cc5f 100644 --- a/docs/administration/upgrade/_index.md +++ b/docs/administration/upgrade/_index.md @@ -55,7 +55,7 @@ Since the migration might alter the database schema and the settings of `harbor. docker image load -i harbor/harbor.[version].tar.gz ``` -1. Upgrade the `harbor.yml` file. +1. Copy the `harbor.yml.tmp` to `harbor.yml` and upgrade it. ```sh docker run -it --rm -v ${harbor_yml}:/harbor-migration/harbor-cfg/harbor.yml goharbor/harbor-migrator:[tag] --cfg up diff --git a/docs/build-customize-contribute/compile-guide.md b/docs/build-customize-contribute/compile-guide.md index bcb4fdab0..c3ec04557 100644 --- a/docs/build-customize-contribute/compile-guide.md +++ b/docs/build-customize-contribute/compile-guide.md @@ -29,7 +29,7 @@ git clone https://github.com/goharbor/harbor ### Configuration -Edit the file **make/harbor.yml** and make necessary configuration changes such as hostname, admin password and mail server. Refer to [Harbor Installation and Configuration](../install-config/_index.md) for more info. +Copy the file **make/harbor.yml.tmp** to **make/harbor.yml**, and make necessary configuration changes such as hostname, admin password and mail server. Refer to [Harbor Installation and Configuration](../install-config/_index.md) for more info. ```sh cd harbor diff --git a/docs/install-config/run-installer-script.md b/docs/install-config/run-installer-script.md index 93fb45fd7..2f3a59f25 100644 --- a/docs/install-config/run-installer-script.md +++ b/docs/install-config/run-installer-script.md @@ -4,7 +4,7 @@ title: Run the Installer Script weight: 35 --- -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` copied from `harbor.yml.tmpl` 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: