Installing in Development mode on WindowsEdit on GitHub
This document describes how to install Spryker in Development Mode on Windows.
Installing Docker prerequisites on Windows
To install Docker prerequisites on Windows with WSL1, follow Installing Docker prerequisites on Windows with WSL1.
To install Docker prerequisites on Windows with WSL2, follow Installing Docker prerequisites on Windows with WSL2.
Installing Spryker in Development mode on Windows
Follow the steps to install Spryker in Development mode:
Open a terminal.
Create a new folder and navigate into it.Important
Avoid using folders that are under a Windows filesystem, because it will slow down all operations significantly (the reason is because Ubuntu <-> Windows filesystem sync).
Depending on the desired Demo Shop:
- Clone the B2C repository:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202204.0-p2 --single-branch ./b2c-demo-shop
- Clone the B2B repository:
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202204.0-p2 --single-branch ./b2b-demo-shop
Depending on the repository you’ve cloned, navigate into the cloned folder:
- B2C repository:
- B2B repository:
Make sure that you are in the correct folder by running the
image:with the PHP image compatible with the current release of the Demo Shop:
- Clone the Docker SDK repository:
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
... xdebug.remote_host=host.docker.internal ... xdebug.client_host=host.docker.internal
- Add your user to the
sudo usermod -aG docker $USER
- Bootstrap local docker setup:
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.
- Open the Start menu.
- In the search field, enter
- Right-click Notepad and select Run as administrator.
- In the User Account Control window, select Yes to confirm the action.
- In the upper navigation panel, select File > Open.
- Put the following path into the address line:
- In the File name line, enter
hostsand select Open. The hosts file opens in the drop-down.
- Follow the installation instructions in the white box from the
docker/sdk bootstrapcommand execution results to prepare the environment.
You can run
bootstrapto get the list of the instructions.Warning
Some versions of Windows have a limitation of the number of hostnames per line. It is recommended not to exceed 10 hostnames per line. Split a long line into multiple lines if necessary.
- Select File > Save.
- Close the file.
Once the job finishes, build and start the instance:
Depending on the hardware performance, the first project launch can take up to 20 minutes.
To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. For more information about the Deploy file, see Deploy file reference - 1.0.
To access RabbitMQ UI, use
spryker as a username and
secret as a password. You can adjust the credentials in
Getting the list of useful commands
To get the full and up-to-date list of commands, run
For submitting the form