Configure TYPO3 for Platform.sh

You now have a project running on Platform.sh. In many ways, a project is just a collection of tools around a Git repository. Just like a Git repository, a project has branches, called environments. Each environment can then be activated. Active environments are built and deployed, giving you a fully isolated running site for each active environment.

Once an environment is activated, your app is deployed through a cluster of containers. You can configure these containers in three ways, each corresponding to a YAML file:

• Configure apps in a .platform.app.yaml file. This controls the configuration of the container where your app lives.
• Add services in a .platform/services.yaml file. This controls what additional services are created to support your app, such as databases or search servers. Each environment has its own independent copy of each service. If you’re not using any services, you don’t need this file.
• Define routes in a .platform/routes.yaml file. This controls how incoming requests are routed to your app or apps. It also controls the built-in HTTP cache. If you’re only using the single default route, you don’t need this file.

Start by creating empty versions of each of these files in your repository:

# Create empty Platform.sh  configuration files
mkdir -p .platform && touch .platform/services.yaml && touch .platform/routes.yaml && touch .platform.app.yaml

Now that you’ve added these files to your project, configure each one for TYPO3 in the following sections. Each section covers basic configuration options and presents a complete example with comments on why TYPO3 requires those values.

Configure apps in .platform.app.yaml

Your app configuration in a .platform.app.yaml file is allows you to configure nearly any aspect of your app. For all of the options, see a complete reference. The following example shows a complete configuration with comments to explain the various settings.

Note that the command php vendor/bin/typo3cms install:generatepackagestate is run during the build hook. The command ensures all installed extensions are enabled and that they can be omitted if you commit your own PackageStates.php file.

Add services in .platform/services.yaml

You can add the managed services you need for you app to run in the .platform/services.yaml file. You pick the major version of the service and security and minor updates are applied automatically, so you always get the newest version when you deploy. You should always try any upgrades on a development branch before pushing to production.

We recommend the latest MariaDB version for TYPO3, although you can also use Oracle MySQL or PostgreSQL if you prefer. We also strongly recommend using Redis for TYPO3 caching. Our TYPO3 template comes pre-configured to use Redis for caching.

You can add other services if desired, such as Solr or Elasticsearch. You need to configure TYPO3 to use those services once they’re enabled.

Each service entry has a name (db and cache in the example) and a type that specifies the service and version to use. Services that store persistent data have a disk key, to specify the amount of storage.

# This file describes an application's services. You can define as many services as your
# application requires, subject to your plan's resource restrictions.
#
# See https://docs.platform.sh/configuration/services.html.

# MariaDB/MySQL 10.4 service with 2048MB of allocated disk.
# The service name `db` is used in defining the `database` relationship in the
# `.platform.app.yaml` file.
# 
# See https://docs.platform.sh/configuration/services/mysql.html.
db:
    type: mysql:10.4
    disk: 2048

# Redis 5.0 service definition. 
# The service name `cache` is used in defining the `rediscache` relationship in the
# `.platform.app.yaml` file.
# 
# See https://docs.platform.sh/configuration/services/redis.html.
cache:
    type: redis:5.0

Define routes

All HTTP requests sent to your app are controlled through the routing and caching you define in a .platform/routes.yaml file.

The two most important options are the main route and its caching rules. A route can have a placeholder of {default}, which is replaced by your domain name in production and environment-specific names for your preview environments. The main route has an upstream, which is the name of the app container to forward requests to.

You can enable HTTP cache. The router includes a basic HTTP cache. By default, HTTP caches includes all cookies in the cache key. So any cookies that you have bust the cache. The cookies key allows you to select which cookies should matter for the cache. Generally, you want the user session cookie, which is included in the example for TYPO3. You may need to add other cookies depending on what additional modules you have installed.

You can also set up routes as HTTP redirects. In the following example, all requests to www.{default} are redirected to the equivalent URL without www. HTTP requests are automatically redirected to HTTPS.

If you don’t include a .platform/routes.yaml file, a single default route is used. This is equivalent to the following:

https://{default}/:
  type: upstream
  upstream: <APP_NAME>:http

Where <APP_NAME> is the name you’ve defined in your app configuration.

The following example presents a complete definition of a main route for a TYPO3 app:

Back Customize TYPO3