Installing in Demo mode on MacOS and Linux

This document describes the procedure of installing Spryker in Demo Mode on MacOS and Linux.

Install Docker prerequisites on MacOS and Linux

To install Docker prerequisites, follow one of the guides:

• Installing Docker prerequisites on MacOS
• Installing Docker prerequisites on Linux

Clone a Demo Shop and the Docker SDK

1. Open a terminal.

2. Create a new folder and navigate into it.

3. Depending on the desired Demo Shop:

   • Clone the B2C repository:

   git clone https://github.com/spryker-shop/b2c-demo-shop.git -b 202204.0-p1 --single-branch ./b2c-demo-shop
   

   • Clone the B2B repository:

   git clone https://github.com/spryker-shop/b2b-demo-shop.git -b 202204.0-p1 --single-branch ./b2b-demo-shop
   

4. Depending on the cloned repository, navigate into the cloned folder:

   • B2C repository:

   cd b2c-demo-shop
   

   • B2B repository:

   cd b2b-demo-shop
   

5. Clone the Docker SDK repository into the same folder:

git clone https://github.com/spryker/docker-sdk.git --single-branch docker

Optional: Switch to ARM architecture

Follow the steps in this section if you are installing on a device with an ARM chip, like Apple M1. Otherwise, configure and start the instance.

Update Sass

Replace x86 based Sass with an ARM based one:

1. In package.json, remove node-sass dependencies.
2. Add sass and sass-loader dependencies:

...
"sass": "~1.32.13",
"sass-loader": "~10.2.0",
...

3. Update @spryker/oryx-for-zed:

...
"@spryker/oryx-for-zed": "~2.11.5",
...

4. In frontend/configs/development.js, add configuration for saas-loader:

loader: 'sass-loader',
options: {
   implementation: require('sass'),
}

5. Enter the Docker SDK CLI:

docker/sdk cli

6. Update package-lock.json and install dependencies based on your package manager:
   • npm:

   npm install
   

   • yarn:

   yarn install
   

7. Rebuild Yves:

npm run yves

8. Rebuild Zed:

npm run zed

Update RabbitMQ and Jenkins services

In the deploy file, update RabbitMQ and Jenkins to ARM supporting versions. Example:

services:
...
    broker:
        engine: rabbitmq
        version: '3.9'
        api:
            username: 'spryker'
            password: 'secret'
        endpoints:
            queue.spryker.local:
            localhost:5672:
                protocol: tcp
...
        scheduler:
        engine: jenkins
        version: '2.324'
        endpoints:
            scheduler.spryker.local:
...

Enable Jenkins CSRF protection

1. In the deploy file, enable the usage of the CSRF variable:

...
services:
  scheduler:
    csrf-protection-enabled: true
...

2. In the config file, enable Jenkins CSRF protection by defining the CSRF variable:

...
$config[SchedulerJenkinsConstants::JENKINS_CONFIGURATION] = [
    SchedulerConfig::SCHEDULER_JENKINS => [
        SchedulerJenkinsConfig::SCHEDULER_JENKINS_CSRF_ENABLED => (bool)getenv('SPRYKER_JENKINS_CSRF_PROTECTION_ENABLED'),
    ],
];
...

Configure and start the instance

1. Bootstrap the local Docker setup for demo:

docker/sdk bootstrap

2. Once the job finishes, build and start the instance:

docker/sdk up

3. Update the hosts file:

echo "127.0.0.1 zed.de.spryker.local yves.de.spryker.local glue.de.spryker.local zed.at.spryker.local yves.at.spryker.local glue.at.spryker.local zed.us.spryker.local yves.us.spryker.local glue.us.spryker.local mail.spryker.local scheduler.spryker.local queue.spryker.local backoffice.de.spryker.local" | sudo tee -a /etc/hosts

Endpoints

To ensure that the installation is successful, make sure you can access the following endpoints.

Getting the list of useful commands

To get the full and up-to-date list of commands, run docker/sdk help.

Next steps

• Spryker in Docker troubleshooting
• Configuring debugging in Docker
• Deploy file reference - 1.0
• Configuring services
• Setting up a self-signed SSL certificate
• Adjusting Jenkins for a Docker environment