Install in Demo mode on Windows
Edit on GitHubThis doc describes how to install Spryker in Demo Mode on Windows.
Install Docker prerequisites on Windows
Depending on the needed WSL version, follow one of the guides:
Clone a Demo Shop and the Docker SDK
-
Open Ubuntu.
-
Open a terminal.
-
Create a new folder and navigate into it.
-
Clone one of the Demo Shops and navigate into its folder:
- B2C Demo Shop:
git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202404.0 --single-branch ./b2c-demo-shop && \ cd b2c-demo-shop
- B2B Demo Shop:
git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202404.0 --single-branch ./b2b-demo-shop && \ cd b2b-demo-shop
- B2C Marketplace Demo Shop
git clone https://github.com/spryker-shop/b2c-demo-marketplace.git -b 202404.0 --single-branch ./b2c-demo-marketplace && \ cd b2c-demo-marketplace
- B2B Marketplace Demo Shop
git clone https://github.com/spryker-shop/b2b-demo-marketplace.git -b 202404.0 --single-branch ./b2b-demo-marketplace && \ cd b2b-demo-marketplace
Make sure that you are in the Demo Shop’s folder by running the pwd
command.
- Clone the Docker SDK repository into the same folder:
git clone https://github.com/spryker/docker-sdk.git --single-branch docker
Configure and start the instance
- Add your user to the
docker
group:
sudo usermod -aG docker $USER
- Bootstrap the local Docker setup for demo:
docker/sdk bootstrap
Once you finish the setup, you don’t need to run bootstrap
to start the instance. You only need to run it after updating the Docker SDK or changing the deploy file.
-
Update the
hosts
file:- Open the Start menu.
- In the search field, enter
Notepad
. - 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:
C:\Windows\System32\drivers\etc
. - In the File name line, enter
hosts
and select Open. The hosts file opens in the drop-down. - Add the following line into the file:
127.0.0.1 spryker.local mail.spryker.local queue.spryker.local scheduler.spryker.local swagger.spryker.local 127.0.0.1 backend-api.at.spryker.local backend-api.de.spryker.local backend-api.us.spryker.local backend-gateway.at.spryker.local backend-gateway.de.spryker.local backend-gateway.us.spryker.local 127.0.0.1 backoffice.at.spryker.local backoffice.de.spryker.local backoffice.us.spryker.local 127.0.0.1 glue.at.spryker.local glue.de.spryker.local glue.us.spryker.local yves.at.spryker.local yves.de.spryker.local yves.us.spryker.local
If needed, add corresponding entries for other stores. For example, if you are going to have a US store, add the following entries:
zed.us.spryker.local glue.us.spryker.local yves.us.spryker.local
- Select File > Save.
- Close the file.
-
Build and start the instance:
docker/sdk up
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 |
the Back Api | backend-api.at.spryker.local backend-api.de.spryker.local backend-api.us.spryker.local |
the Back Gateway | backend-gateway.at.spryker.local backend-gateway.de.spryker.local backend-gateway.us.spryker.local |
Glue API | glue.de.spryker.local, glue.at.spryker.local, glue.us.spryker.local |
Jenkins (scheduler) | scheduler.spryker.local |
RabbitMQ UI (queue manager) | queue.spryker.local |
Mailhog UI (email catcher) | mail.spryker.local |
Swagger | swagger.spryker.local |
Dashboard | spryker.local |
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 to learn about the Deploy file.
Get the list of useful commands
To get the full and up-to-date list of commands, run docker/sdk help
.
Next steps
Thank you!
For submitting the form