diff --git a/docs/06-installation/02-installation-guides/02-installing-in-development-mode-on-macos-and-linux.md b/docs/06-installation/02-installation-guides/02-installing-in-development-mode-on-macos-and-linux.md index ca4982806..7533cfa4d 100644 --- a/docs/06-installation/02-installation-guides/02-installing-in-development-mode-on-macos-and-linux.md +++ b/docs/06-installation/02-installation-guides/02-installing-in-development-mode-on-macos-and-linux.md @@ -65,6 +65,7 @@ $ docker-compose --version ::: 7. Bootstrap local docker setup: + ```bash docker/sdk bootstrap deploy.dev.yml ``` @@ -72,35 +73,27 @@ docker/sdk bootstrap deploy.dev.yml Once you finish the setup, you don't need to run `bootstrap` to start the instance. You only need to run it after you update the Docker SDK or the deploy file. ::: -8. Once the job finishes, build and start the instance: -```bash -docker/sdk up -``` +8. Update the `hosts` file: +Follow the installation instructions in the white box from the `docker/sdk bootstrap` command execution results to prepare the environment. -9. Update the `hosts` file: +:::(Info) () + You can run `docker/sdk install` after `bootstrap` to get the list of the instructions. +::: + +9. Once the job finishes, build and start the instance: + ```bash -echo "127.0.0.1 backoffice.de.spryker.local backend-gateway.de.spryker.local backend-api.de.spryker.local yves.de.spryker.local glue.de.spryker.local backoffice.at.spryker.local backend-gateway.at.spryker.local backend-api.at.spryker.local yves.at.spryker.local glue.at.spryker.local backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local yves.us.spryker.local glue.us.spryker.local mail.spryker.local scheduler.spryker.local queue.spryker.local" | sudo tee -a /etc/hosts +docker/sdk up ``` -@(Info)()(If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries: `backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local glue.us.spryker.local yves.us.spryker.local`) @(Warning)()(Depending on the hardware performance, the first project launch can take up to 20 minutes.) ## Endpoints -To ensure that the installation is successful, make sure you can access the following endpoints. - -| Application | Endpoints | -| --- | --- | -| The Storefront | yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local | -| the Back Office | backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.us.spryker.local | -| Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local | -| The Merchant Portal | mp.de.spryker.local, mp.at.spryker.local, mp.us.spryker.local | -| Jenkins (scheduler) | scheduler.spryker.local | -| RabbitMQ UI (queue manager) | queue.spryker.local | -| Mailhog UI (email catcher) | mail.spryker.local | +To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. :::(Info) (RabbitMQ UI credentials) -To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. +To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. ::: ## Getting the list of useful commands diff --git a/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md b/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md index 2623c8f3c..21a0ee258 100644 --- a/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md +++ b/docs/06-installation/02-installation-guides/03-installing-in-development-mode-on-windows.md @@ -83,12 +83,7 @@ docker/sdk bootstrap deploy.dev.yml Once you finish the setup, you don't need to run `bootstrap` to start the instance. You only need to run it after you update the Docker SDK or the deploy file. ::: -11. Once the job finishes, build and start the instance: -```bash -docker/sdk up -``` - -12. Update the `hosts` file: +11. Update the `hosts` file: 1. Open the Start menu. 2. In the search field, enter `Notepad`. 3. Right-click *Notepad* and select **Run as administrator**. @@ -97,33 +92,29 @@ docker/sdk up 6. Put the following path into the address line: `C:\Windows\System32\drivers\etc`. 7. In the **File name** line, enter `hosts` and select **Open**. The hosts file opens in the drop-down. - 8. Add the following line into the file: - ```text - 127.0.0.1 backoffice.de.spryker.local backend-gateway.de.spryker.local backend-api.de.spryker.local glue.de.spryker.local yves.de.spryker.local scheduler.spryker.local mail.spryker.local queue.spryker.local - ``` - @(Info)()(If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries: `backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local glue.us.spryker.local yves.us.spryker.local`) + 8. Follow the installation instructions in the white box from the `docker/sdk bootstrap` command execution results to prepare the environment. + :::(Info) () + You can run `docker/sdk install` after `bootstrap` to get the list of the instructions. + ::: 9. Select **File** > **Save**. 10. Close the file. +12. Once the job finishes, build and start the instance: + +```bash +docker/sdk up +``` -@(Warning)()(Depending on the hardware performance, the first project launch can take up to 20 minutes.) +:::(Warning) () +Depending on the hardware performance, the first project launch can take up to 20 minutes. +::: ## Endpoints -To ensure that the installation is successful, make sure you can access the following endpoints. - -| Application | Endpoints | -| --- | --- | -| The Storefront | yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local | -| the Back Office | backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.us.spryker.local | -| Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local | -| The Merchant Portal | mp.de.spryker.local, mp.at.spryker.local, mp.us.spryker.local | -| Jenkins (scheduler) | scheduler.spryker.local | -| RabbitMQ UI (queue manager) | queue.spryker.local | -| Mailhog UI (email catcher) | mail.spryker.local | +To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. :::(Info) (RabbitMQ UI credentials) -To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. +To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. ::: ## Getting the list of useful commands diff --git a/docs/06-installation/02-installation-guides/04-installing-in-demo-mode-on-macos-and-linux.md b/docs/06-installation/02-installation-guides/04-installing-in-demo-mode-on-macos-and-linux.md index 570bab2d1..e2fe1df66 100644 --- a/docs/06-installation/02-installation-guides/04-installing-in-demo-mode-on-macos-and-linux.md +++ b/docs/06-installation/02-installation-guides/04-installing-in-demo-mode-on-macos-and-linux.md @@ -70,39 +70,32 @@ Once you finish the setup, you don't need to run `bootstrap` to start the instan * Docker SDK version update; * Deploy file update. ::: -7. Once the job finishes, build and start the instance: + +7. Update the `hosts` file: +Follow the installation instructions in the white box from the `docker/sdk bootstrap` command execution results to prepare the environment. +:::(Info) () +You can run `docker/sdk install` after `bootstrap` to get the list of the instructions. +::: + +8. Once the job finishes, build and start the instance: + ```shell docker/sdk up ``` -8. Update the `hosts` file: -```bash -echo "127.0.0.1 backoffice.de.spryker.local backend-gateway.de.spryker.local backend-api.de.spryker.local yves.de.spryker.local glue.de.spryker.local backoffice.at.spryker.local backend-gateway.at.spryker.local backend-api.at.spryker.local yves.at.spryker.local glue.at.spryker.local backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local yves.us.spryker.local glue.us.spryker.local mail.spryker.local scheduler.spryker.local queue.spryker.local" | sudo tee -a /etc/hosts -``` -@(Info)()(If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries: `backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local glue.us.spryker.local yves.us.spryker.local`) - -@(Warning)()(Depending on the hardware performance, the first project launch can take up to 20 minutes.) +:::(Warning) () +Depending on the hardware performance, the first project launch can take up to 20 minutes. +::: ## Endpoints -To ensure that the installation is successful, make sure you can access the following endpoints. - -| Application | Endpoints | -| --- | --- | -| The Storefront | yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local | -| the Back Office | backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.us.spryker.local | -| Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local | -| The Merchant Portal | mp.de.spryker.local, mp.at.spryker.local, mp.us.spryker.local | -| Jenkins (scheduler) | scheduler.spryker.local | -| RabbitMQ UI (queue manager) | queue.spryker.local | -| Mailhog UI (email catcher) | mail.spryker.local | +To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. :::(Info) (RabbitMQ UI credentials) -To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. +To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. ::: - ## Getting the list of useful commands To get the full and up-to-date list of commands, run `docker/sdk help`. diff --git a/docs/06-installation/02-installation-guides/05-installing-in-demo-mode-on-windows.md b/docs/06-installation/02-installation-guides/05-installing-in-demo-mode-on-windows.md index 75164f13d..d7979ca82 100644 --- a/docs/06-installation/02-installation-guides/05-installing-in-demo-mode-on-windows.md +++ b/docs/06-installation/02-installation-guides/05-installing-in-demo-mode-on-windows.md @@ -85,37 +85,29 @@ docker/sdk up 6. Put the following path into the address line: `C:\Windows\System32\drivers\etc`. 7. In the **File name** line, enter `hosts` and select **Open**. The hosts file opens in the drop-down. - 8. Add the following line into the file: - ```text - 127.0.0.1 backoffice.de.spryker.local backend-gateway.de.spryker.local backend-api.de.spryker.local glue.de.spryker.local yves.de.spryker.local scheduler.spryker.local mail.spryker.local queue.spryker.local - ``` - @(Info)()(If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries: `backoffice.us.spryker.local backend-gateway.us.spryker.local backend-api.us.spryker.local glue.us.spryker.local yves.us.spryker.local`) + 8. Follow the installation instructions in the white box from the `docker/sdk bootstrap` command execution results to prepare the environment. + :::(Info) () + You can run `docker/sdk install` after `bootstrap` to get the list of the instructions. + ::: 9. Select **File** > **Save**. 10. Close the file. -@(Warning)()(Depending on the hardware performance, the first project launch can take up to 20 minutes.) +:::(Warning) () +Depending on the hardware performance, the first project launch can take up to 20 minutes. +::: ## Endpoints -To ensure that the installation is successful, make sure you can access the following endpoints. - -| Application | Endpoints | -| --- | --- | -| The Storefront | yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local | -| the Back Office | backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.us.spryker.local | -| Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local | -| The Merchant Portal | mp.de.spryker.local, mp.at.spryker.local, mp.us.spryker.local | -| Jenkins (scheduler) | scheduler.spryker.local | -| RabbitMQ UI (queue manager) | queue.spryker.local | -| Mailhog UI (email catcher) | mail.spryker.local | +To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](https://documentation.spryker.com/docs/deploy-file-reference-10) to learn about the Deploy file. :::(Info) (RabbitMQ UI credentials) -To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file. +To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. ::: + ## Getting the list of useful commands To get the full and up-to-date list of commands, run `docker/sdk help`. diff --git a/docs/06-installation/02-installation-guides/06-integrating-the-docker-sdk-into-existing-projects.md b/docs/06-installation/02-installation-guides/06-integrating-the-docker-sdk-into-existing-projects.md index 489e10cbe..1a3cb959e 100644 --- a/docs/06-installation/02-installation-guides/06-integrating-the-docker-sdk-into-existing-projects.md +++ b/docs/06-installation/02-installation-guides/06-integrating-the-docker-sdk-into-existing-projects.md @@ -95,20 +95,10 @@ Ensure that, in the `hosts` file in the local environment, all the domains from ## Endpoints -To ensure that the installation is successful, make sure you can access the following endpoints. - -| Application | Endpoints | -| --- | --- | -| The Storefront | yves.de.spryker.local, yves.at.spryker.local, yves.us.spryker.local | -| the Back Office | backoffice.de.spryker.local, backoffice.at.spryker.local, backoffice.us.spryker.local | -| Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local | -| The Merchant Portal | mp.de.spryker.local, mp.at.spryker.local, mp.us.spryker.local | -| Jenkins (scheduler) | scheduler.spryker.local | -| RabbitMQ UI (queue manager) | queue.spryker.local | -| Mailhog UI (email catcher) | mail.spryker.local | +To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](https://documentation.spryker.com/docs/deploy-file-reference-10) to learn about the Deploy file. :::(Info) (RabbitMQ UI credentials) -To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. See [Deploy File Reference - 1.0](https://documentation.spryker.com/docs/deploy-file-reference-10#deploy-file-reference---1-0) to learn about the Deploy file. +To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`. :::