Deploy a Symfony app

Symfony is a PHP web framework that helps you speed up the development of your PHP-based web apps.

Deploying Symfony apps with Cleavr is quick and painless.

In this guide, we will setup and deploy the demo blog application.

Step 1: Install Demo Project On Your Local

First, work through the instructions on the demo project's readme file to copy the project to your local environment.

Run the app on your local to make sure it runs as expected.

Add the project to your favorite Git repo; make sure to not save the .env file to your repo.

Step 2: Provision New Server

In Cleavr, provision a new server. Make sure to install a version of PHP as well as NodeJS.

Step 3: Add A PHP Site

Once the server is finished provisioning, add a new PHP site to the server.

When adding the PHP site, set the Web Directory to point to the public folder.

Step 4: Set Up Database (optional)

The demo app, by default, is configured to use a sqlite db. However, you can set up the app to use MySQL or Postgres.

In this example, we'll setup a MySQL server.

In Cleavr > Server > click the database tab and install MySQL 8.0.

Once installed, add a new database with a corresponding user and password.

Remember the credentials as we'll use these later when setting up the environment variables.

Step 5: Configure Deployment Workflow

Once the site has been added, go to the deployment workflow section and click Complete Setup for the deployment workflow that was just added after creating the new site.

Configure Code Repository

Configure the app to pull from the repository you are storing your code on and also identify the branch to deploy.

Click Update.

Configure .env

Select the Environment tab and then add in the environment variables for the app.

Below is the default added to the project. Use it as reference to add in the required variables.

Make sure to set APP_ENV to prod.

# In all environments, the following files are loaded if they exist,
# the latter taking precedence over the former:
#  * .env                contains default values for the environment variables needed by the app
#  * .env.local          uncommitted file with local overrides
#  * .env.$APP_ENV       committed environment-specific defaults
#  * .env.$APP_ENV.local uncommitted environment-specific overrides
# Real environment variables win over .env files.
# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).

###> symfony/framework-bundle ###
# TRUSTED_HOSTS='^(localhost|kxduvgrzle1308\.cleaver\.rocks)$'
###< symfony/framework-bundle ###

###> doctrine/doctrine-bundle ###
# Format described at
# For a MySQL database, use: "mysql://db_user:db_password@"
# For a PostgreSQL database, use: "postgresql://db_user:db_password@"
# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
###< doctrine/doctrine-bundle ###

###> symfony/mailer ###
# MAILER_DSN=smtp://localhost
###< symfony/mailer ###

If you added the MySQL database in the previous steps, replace user, password, and db_name on the DATABASE_URL string.

Configure deployment hooks

In the Hooks section, enable Install Composer Dependencies and Install Yarn Packages hooks.

We'll also need to add a new hook with the build command.

cd {{ releasePath }}
npm run build

Place the hook below Install Yarn Packages.

Step 6: Deploy!

If everything is configured and looks good, deploy! 🚀

Troubleshooting and Resources

Look for additional deployment tips? Check out the How to Deploy a Symfony Application Symfony documentations.

Looking for the Symfony error logs?

They are typically located in: