Deploy TYPO3


If you have been customizing your existing project as you go, now is the time to ensure all code is committed to Git and to run git push to to your production branch. then builds your code, producing a read-only image of your application, and deploys it into a running cluster of containers.

You can view the process in the console or, if you aren't using a source integration, in your terminal after pushing. When the process is done, click the URL to see your site.

Post-install (new site) 

The following section is only relevant when deploying the TYPO3 template or creating a new site from scratch locally using Composer. If you’re migrating an existing site, you can move on to the next step.

    # The deploy hook runs after your application has been deployed and started.
    # Code can't be modified at this point but the database is available.
    # The site isn't accepting requests while this script runs so keep it
    # fast.
    deploy: |
        # Exit hook immediately if a command exits with a non-zero status.
        set -e

        # Set TYPO3 site defaults on first deploy.
        if [ ! -f var/platformsh.installed ]; then
            # Copy the created LocalConfiguration into the writable location.
            cp public/typo3conf/LocalConfiguration.FromSource.php var/LocalConfiguration.php

            # On first install, create an inital admin user with a default password.
            php vendor/bin/typo3cms install:setup \
                --install-steps-config=src/SetupDatabase.yaml \
                --site-setup-type=no \
                --site-name="TYPO3 on" \
                --admin-user-name=admin \
                --admin-password=password \
                --skip-extension-setup \

            # Sets up all extensions that are marked as active in the system.
            php vendor/bin/typo3cms extension:setupactive || true

            # Create file that indicates first deploy and installation has been completed.
            touch var/platformsh.installed

The template is designed to run the TYPO3 installer only on the first deploy by creating a placeholder platformsh.installed on the var mount. You should not remove this file unless you want the next deployment to run through the installer again.

Next, when the deploy hook ran through the installer, it set an initial username and password for the TYPO3 site, which you should update immediately. Visit /typo3 on the generated URL for the environment and login with those temporary admin credentials. Then click on the user icon in the top right of the page and go to User Settings > Password to update.

Data migration 

If you are moving an existing site to, then in addition to code you also need to migrate your data. That means your database and your files.

Importing the database 

First, obtain a database dump from your current site. If you are using MySQL/MariaDB, then the mysqldump command is all you need. Save your dump file as database.sql. (Or any name, really, as long as it’s the same as you use below.)

Next, import the database into your site. The easiest way to do so is with the CLI.

platform sql -e production < database.sql

That connects to the database service on the production environment, through an SSH tunnel, and runs the SQL import.

Importing files 

You first need to download your files from your current hosting environment, whatever that is. The easiest way is likely with rsync, but consult your old host’s documentation. This guide assumes that you have already downloaded all of your user files to your local files/user directory and your public files to files/public , but adjust accordingly for their actual locations.

The platform mount:upload command provides a straightforward way to upload an entire directory to your site at once. Under the hood, it uses an SSH tunnel and rsync, so it’s as efficient as possible. (There is also a platform mount:download command you can use to download files later.) Run the following from your local Git repository root (modifying the --source path if needed and setting <BRANCH_NAME> to the branch you are using).

$ platform mount:upload -e <BRANCH_NAME> --mount src/main/resources/files/user --source ./files/user
$ platform mount:upload -e <BRANCH_NAME> --mount src/main/resources/files/public --source ./files/public

Note that rsync is picky about its trailing slashes, so be sure to include those.

Your files and database are now loaded onto your production environment. When you make a new branch environment off of it, all of your data is fully cloned to that new environment so you can test with your complete dataset without impacting production.

Go forth and Deploy (even on Friday)!