Skip to content

Setup Template

Setup Template

The setup template is installed automatically using Symfony Flex when requiring the paas package as described in the Repository. It contains build and deployment logic for Shopware PaaS as well as configuration for the underlying infrastructure and services. In this chapter, we will have a look at these customizations.

Below is an overview of the files and directories added by the PaaS meta-package:

text
./
├─ .platform/
│  ├─ applications.yaml
│  ├─ routes.yaml
│  ├─ services.yaml
├─ bin/
│  ├─ prestart_cacheclear.sh
├─ config/
│  ├─ packages/
│  │  ├─ paas.yaml
├─ files/
│  ├─ theme-config/

.platform/applications.yaml

This file contains Shopware PaaS specific configuration and can be customized as needed for your individual project.

name

It is the name of your app. It is used in commands like:

bash
shopware ssh -A app 'bin/console theme:dump'

Unless there is a specific need for it, leave it as app.

type

This section contains the base image used for your build process. This is also where you configure the PHP version used in your PaaS environment.

variables

This section contains configuration for environment variables or server settings. General store settings and configurations are set here. Here you can inject custom environment variables or enable feature flags.

Variables in the env section are automatically injected as environment variables. If a variable is also set in your .env file, the variables set in the applications.yaml file will overwrite these.

hooks

Lifecycle hooks are custom scripts that are called during your build and deploy processes. See more on the deployment process.

build hook

This script is called during the build process and builds your application's assets (composer dependencies, javascript- and css- assets of Shopware core and extensions) and disables the UI installer. You can customize this script if you need. During the execution, you may perform write operations on the file system, which are prohibited in the proceeding steps unless the corresponding directory is mounted.

You do not have access to any of the services (like the database or Redis) configured, as the application is not running yet. You should ensure to perform as much of your entire building procedure during the build step, as web traffic is blocked during the execution of the deploy step.

deploy hook

WARNING

The environment will be cut off from web traffic during the execution of the deploy hook. The shorter this script is, the shorter the downtime will be.

This script is called during the deployment process. Theme configuration is copied, the install scripts are executed and secrets are generated.

  • Copy theme configuration
  • Run database migrations
  • Set sales channel domains for non-production environments
  • Clear cache

If this is the first deployment, the following operations are performed:

  • Setup script is executed
  • Theme is set
  • Secrets are generated
  • installer/installed file is created

You can also customize this script, however, make sure to keep operations to a minimum, as your store will not be exposed to web traffic during the execution. Connections made during the meantime will be queued in a suspended state and not necessarily fail but will take longer than usual (i.e., until the deployment has finished).

post_deploy

Analogous to the two preceding hooks, the post_deploy hook provides an entry point for custom scripts. However, this hook is executed after the application container accepts connections.

relationships

This section defines the mapping between services created in the services.yaml and the application itself.

mounts

By default, the entire storage of your application is read-only. Mounts define directories that are writable after the build is complete. They aren’t available during the build.

Every mount has one of two types: local or service. A local mount is unique to the service that is accessing it. For example /var/cache is a good local mount because the Symfony cache should not be shared between different app servers. A service mount references to another service (of the type network-storage). These mounts are shared between other services and between the different app servers. For example the /public/media folder is a good shared mount because the workers that consume the Messenger queue should be able to read and write to the media directory.

web

The public root of your application public/index.php is configured so the server knows where to route dynamic requests.

workers

Workers are copies of your application instance after the build hook has been executed. They are usually configured with a start command. By default, there are two configured workers - one for message queues and one for scheduled tasks.

.platform / routes.yaml

This file configures incoming HTTP requests routed to the app instance.

.platform / services.yaml

This file contains services that are used by the app instances. Depending on your setup, uncomment or add services that you need, and they will be created and scaled automatically.

In our template there are 4 different services enabled by default:

  • db
  • cacheredis
  • rabbitmq
  • fileshare

files / theme-config

We suggest checking in your theme configuration to version control in this directory. Read more on the concept of builds without database as described in Theme Build.