Configure Spryker after installing

Edit on GitHub

This document describes how to configure Spryker after installing it.

Configuration of services

Spryker provides an easily manageable and extendable way to configure required services according to the predefined deploy.*.yml file that contains a services section which describes services used to deploy Spryker applications for different environments.

Configuration can be defined on different levels: project-wide, region-wide, store-specific or endpoint-specific with limitations depending on the service type.

Below, you can find an example of the service declaration that represents the type and configuration of the broker service.

...
services:
    // Defines the service name
    broker:
        engine: rabbitmq
        // Defines the list of the environment variables
        api:
            username: "spryker"
            password: "secret"
        // Defined the list of Endpoints that points to the Service web interface or service's port
        endpoints:
            queue.demo-spryker.com:
...

Configuration of endpoints

Endpoint is a point of access to a Spryker application or service.

Individual endpoints and ports are set in deploy.*.yml file.

Key format: domain[:port]. By default, the port for HTTP endpoints is 80. A port is mandatory for TCP endpoints.

Configure by editing deploy files

  1. To configure an application per your requirements, edit deploy.*.yml.
...
groups:
    EU:
        region: EU
        applications:
            yves_eu:
                application: yves
                endpoints:
                    {endpointName}:
                        store: DE
                        services:
                            session:
                                namespace: 1
...
  1. Bootstrap the local docker setup:
docker/sdk boot
  1. Once the job finishes, build and start the instance:
docker/sdk up
  1. Update the hosts file:
echo "127.0.0.1 {endpointName}" | sudo tee -a /etc/hosts