.magento.app.yaml

About .magento.app.yaml

Magento Commerce supports multiple applications per project but typically, a project is composed of a single application, in which case you can simply put a .magento.app.yaml at the root of your repository.

This file controls the application and the way it is built and deployed on Magento Commerce (Cloud). To see a sample of the file, see .magento.app.yaml. Make sure to review the .magento.app.yaml for your installed version. This file can differ across Magento Commerce (Cloud) versions.

The following sections discuss properties in .magento.app.yaml.

Defaults

.magento.app.yaml has many default values; see the sample .magento.app.yaml.

name property

name identifies the application in the project. Magento Commerce supports multiple applications in a project, so each application must have a unique name in a project.

name can consist only of lower case alphanumeric characters; that is, a–z and 0–9. name is used in the routes.yaml to define the HTTP upstream (by default, php:php).

For example, if the value of name is app, you must use app:php in the upstream field. You can also use this name in multi-application relationships.

type and build

The type and build properties are used to build and run the project. The only supported type currently is PHP.

Supported versions for 2.0.X to 2.1.X:

type: php:5.5
type: php:5.6
type: php:7.0

The build determines what happens by default when building the project. The only value currently supported is composer.

Example:

type: php:7.0
build:
    flavor: composer

access

access defines the user roles who can log in using SSH to the environments to which they have access.

Possible values are:

ssh: admin
ssh: contributor
ssh: viewer

relationships

relationships defines how services are mapped in your application.

The left-hand side is the name of the relationship as it will be exposed to the application in the MAGENTO_CLOUD_RELATIONSHIPS environment variable. The right-hand side is in the form <service name>:<endpoint name>, where <service name> comes from .magento/services.yaml and <endpoint name> should be the same as the value of type declared in that same file.

Example of valid options are:

database: "mysql:mysql"
database2: "mysql2:mysql"
cache: "arediscache:redis"
search: "searchengine:solr"

See also services.yaml documentation for a full list of currently supported service types and endpoints.

web

web defines how your application is exposed to the web (in HTTP). Here we tell the web application how to serve content, from the front-controller script to a non-static request to an index.php file on the root. We support any directory structure so the static file can be in a sub directory, and the index.php file can be further down.

web supports the following:

• document_root: The path relative to the root of the application that is exposed on the web. Typical values include /public and /web.
• passthru: The URL used in the event a static file or PHP file could not be found. This would typically be your applications front controller, often /index.php or /app.php.
• index_files: To use a static file (for example, index.html) to serve your application. This key expects a collection. For this to work, the static file(s) should be included in your whitelist. For example, to use a file named index.html as an index file, your whitelist should include an element that matches the filename, like - \.html$.
• blacklist: A list of files that should never be executed. Has no effect on static files.
• whitelist: A list of static files (as regular expressions) that can be served. Dynamic files (for example, PHP files) are treated as static files and have their source code served, but they are not executed.
• expires: The number of seconds whitelisted (that is, static) content should be cached by the browser. This enables the cache-control and expires headers for static content. The expires directive and resulting headers are left out entirely if this isn’t set.

Contrary to standard .htaccess approaches, which accept a blacklist and allow everything to be accessed except a specific list, we accept a whitelist, which means that anything not matched will trigger a 404 error and will be passed through to your passthru URL.

Our default configuration allows the following:

• From the root (/) path, only web, media, and robots.txt files can be accessed
• From the /pub/static and /pub/media paths, any file can be accessed

The following displays the default set of web accessible locations associated with an entry in mounts:

# The configuration of app when it is exposed to the web.
web:
locations:
    "/":
        # The public directory of the app, relative to its root.
        root: "pub"
        # The front-controller script to send non-static requests to.
        passthru: "/index.php"
        index:
            - index.php
        expires: -1
        scripts: true
        allow: false
        rules:
            \.(css|js|map|hbs|gif|jpe?g|png|tiff|wbmp|ico|jng|bmp|svgz|midi?|mp?ga|mp2|mp3|m4a|ra|weba|3gpp?|mp4|mpe?g|mpe|ogv|mov|webm|flv|mng|asx|asf|wmv|avi|ogx|swf|jar|ttf|eot|woff|otf|html?)$:
                allow: true
            /robots\.txt$:
                allow: true
    "/media":
        root: "pub/media"
        allow: true
        scripts: false
        passthru: "/index.php"
    "/static":
        root: "pub/static"
        allow: true
        scripts: false
        passthru: "/front-static.php"
        rules:
            ^/static/version\d+/(?<resource>.*)$:
                  passthru: "/static/$resource"

disk

disk defines the size of the persistent disk size of the application in MB.

mounts

mounts is an object whose keys are paths relative to the root of the application. The mount is a writable area on the disk for files. It’s in the form volume_id[/subpath].

The following is a default list of mounts configured in magento.app.yaml:

# The mounts that will be performed when the package is deployed.
mounts:
    "var": "shared:files/var"
    "app/etc": "shared:files/etc"
    "pub/media": "shared:files/media"
    "pub/static": "shared:files/static"

The format for adding your mount to this list is as follows:

"/public/sites/default/files": "shared:files/files"

• shared means that the volume is shared between your applications inside an environment.
• disk key defines the size available for that shared volume

If you also want the mount web accessible, you must add it to the web block of locations.

dependencies

dependencies enables you to specify dependencies that your application might need during the build process.

Magento Commerce supports dependencies on the following languages:

• PHP
• Ruby
• NodeJS

Those dependencies are independent of the eventual dependencies of your application, and are available in the PATH, during the build process and in the runtime environment of your application.

You can specify those dependencies as follows:

ruby:
   sass: "~3.4"
nodejs:
   grunt-cli: "~0.3"

hooks

Use the hooks section to specify which shell commands to run during the build and deploy phases. For example, you may want to run a CLI command provided by a custom extension during the build phase.

• build—Execute commands before packaging your application. Services, such as the database or Redis, are not available at this time since the application has not been deployed yet. You must add custom commands before the default php ./vendor/bin/m2-ece-build command to make sure custom-generated content makes it to the deployment phase.
• deploy—Execute commands after packaging and deploying your application. You can access other services at this point. Since the default php ./vendor/bin/m2-ece-deploy command copies the app/etc directory to correct location, you must add custom commands after the deploy command to prevent custom commands from failing.

Add CLI commands under the build or deploy sections:

hooks:
    # We run build hooks before your application has been packaged.
    build: |
        php ./bin/magento <custom-command>
        php ./vendor/bin/m2-ece-build
    # We run deploy hook after your application has been deployed and started.
    deploy: |
        php ./vendor/bin/m2-ece-deploy
        php ./bin/magento <custom-command>

The home directory, where your application is mounted, is /app, and that is the directory from which hooks will be run unless you cd somewhere else.

The hooks fail if the final command in them fails. To cause them to fail on the first failed command, add set -e to the beginning of the hook.

[Example] Compile SASS files using grunt

For example, to compile SASS files using grunt:

dependencies:
  ruby:
    sass: "3.4.7"
  nodejs:
    grunt-cli: "~0.1.13"

hooks:
  build: |
    cd public/profiles/project_name/themes/custom/theme_name
    npm install
    grunt
    cd
    php ./bin/magento magento-cloud:build

You must compile SASS files using grunt before static content deployment, which happens during the build. Place the grunt command before the build command.

crons

crons describes processes that are triggered on a schedule. We recommend you run cron as the Magento file system owner. Do not run cron as root. We also recommend against running cron as the web server user.

More information about crons:

crons supports the following:

• spec: The cron specification. The minimum interval is once per 5 minutes.
• cmd: The command to execute.

A sample Magento cron job follows:

crons:
  cronrun:
      spec: "*/5 * * * *"
      cmd: "php bin/magento cron:run"

Configure PHP options

You can choose which version of PHP you want to run in your .magento.app.yaml file.:

name: myphpapp
type: php:5.6

For Magento Commerce (Cloud) 2.0.X - 2.1.X we support 5.5, 5.6, and 7.0.

See one of the following sections for more information:

• PHP extensions
• Customize php.ini settings

PHP extensions

You can define additional PHP extensions you want to enable or disable. Example:

# .magento.app.yaml
runtime:
    extensions:
        - xdebug
        - redis
        - ssh2
    disabled_extensions:
        - sqlite3

To view the current list of PHP extensions, SSH into your environment and enter the following command:

php -m

Magento requires the following PHP extensions that are enabled by default:

• curl
• gd
• intl

• PHP 7 only:

  • json
  • iconv
• mcrypt
• PDO/MySQL
• bc-math
• mbstring
• mhash
• openssl
• SimpleXML
• soap
• xml
• zip

You must install the following extensions:

• ImageMagick 6.3.7 (or later), ImageMagick can optionally be used with the gd extension
• xsl
• redis

In addition, we strongly recommend you enable opcache.

Other PHP extensions you can optionally install:

• apcu
• blackfire
• enchant
• gearman
• geoip
• imap
• ioncube
• pecl-http
• pinba
• propro
• pspell
• raphf
• readline
• recode
• snmp
• sqlite3
• ssh2
• tidy
• xcache
• xdebug
• xhprof
• xmlrpc

Customize php.ini settings

You can also create and push a php.ini file that is appended to the configuration maintained by Magento Commerce.

In your repository, the php.ini file should be added to the root of the application (the repository root).

For example, if you need to increase the PHP memory limit:

memory_limit = 756M

For a list of recommended PHP configuration settings, see Required PHP settings.

After pushing your file, you can check that the custom PHP configuration has been added to your environment by creating an SSH tunnel to your environment and entering:

cat /etc/php5/fpm/php.ini

Related topics

• Get started with a project
• routes.yaml
• services.yaml