Setting up a custom domain name with a third-party DNS zone provider

Edit on GitHub

This document describes how to set up a custom domain name (domain) with a third-party DNS zone provider.

1. Point domain names to load balancers

To point a domain to your application, point it to the respective load balancer as follows:

  1. In the AWS Management Console, go to Services > EC2 > Load Balancers.

  2. Depending on the environment, select one of the load balancers with the application type:

    • {project_name}-staging
    • {project_name}-prod
  3. In the Load balancer:{load balancer name} section, select Copy copy icon next to the DNS name field.

  4. On the side of the DNS zone provider, set up a CNAME record using the copied DNS name as the record value. Refer to the DNS zone provider’s documentation for details.

2. Define domain names

In Spryker Cloud Commerce OS, infrastructure deployment is based on the application configuration.

Domains are defined in a deploy.*.yml file used by the Docker SDK tool to build applications.

To define a custom domain, edit deploy.{project_name}-prod.yml for the production environment or deploy.{project_name}-staging.yml for the staging environment:

  1. Find the desired group:.
  2. In the group: applications:, find the desired application.
  3. In the endpoints: section of the desired application, set the domain and its store relation:
groups:
    DE-1:
        region: DE
        applications:
            Yves:
                application: yves
                endpoints:
                    {domain_name}:
                        store: {store_relation}

Example:

groups:
    DE-1:
        region: DE
        applications:
            Yves:
                application: yves
                endpoints:
                    www.de.mysprykershop.com:
                        store: DE
Store configuration

store: must correspond to groups: and region:. For example, it is impossible to set a US store in the DE region.

See Deploy file reference to learn more about deploy file configuration.

  1. Depending on the environment you are setting up the domain for:

Next step

Setting up a custom SSL certificate