Get started

Upsun is the official Symfony PaaS. This guide provides instructions for deploying, and working with, Symfony on Upsun.

Before you begin

You need:

• Git. Git is the primary tool to manage everything your app needs to run. Push commits to deploy changes and control configuration through YAML files. These files describe your infrastructure, making it transparent and version-controlled.
• A Upsun account. If you don’t already have one, register for a trial account. You can sign up with an email address or an existing GitHub, Bitbucket, or Google account. If you choose one of these accounts, you can set a password for your Upsun account later.
• The Symfony CLI. This lets you interact with your project from the command line. You can also do most things through the Web Console.

1. Create your Symfony app

To get familiar with Upsun, create a new Symfony project from scratch. The present tutorial uses the Symfony Demo app as an example :

symfony new PROJECT_NAME --demo --upsun
cd PROJECT_NAME

The --demo flag pulls the Symfony Demo skeleton.
The --upsun flag automatically generates the Upsun configuration file.

2. Create your Upsun project

To create a project on Upsun, run the following command from within the project’s directory:

symfony upsun:create --title PROJECT_TITLE --set-remote

The --set-remote flag sets the new project as the remote for this repository.

symfony upsun:set-remote PROJECT_ID

3. Deploy your project

To deploy your project, run the following command:

symfony upsun:deploy

During deployment, the logs from the Upsun API are displayed in your terminal so you can monitor progress. To stop the display of the logs without interrupting the deployment, use CTRL+C in your terminal. To go back to displaying the logs, run symfony upsun:activity:log.

Congratulations, your first Symfony app has been deployed on Upsun!

symfony upsun:domain:add YOUR_DOMAIN

4. Make changes to your project

Now that your project is deployed, you can start making changes to it. For example, you might want to fix a bug or add a new feature.

In your project, the main branch always represents the production environment. Other branches are for developing new features, fixing bugs, or updating the infrastructure.

To make changes to your project, follow these steps:

1. Create a new environment (a Git branch) to make changes without impacting production:

   Terminal

   symfony upsun:branch feat-a

   This command creates a new local feat-a Git branch based on the main Git branch, and activates a related environment on Upsun. The new environment inherits the data (service data and assets) of its parent environment (the production environment here).

2. Make changes to your project.

   For example, if you created a Symfony Demo app, edit the templates/default/homepage.html.twig template and make the following visual changes:

   templates/default/homepage.html.twig

   {% block body %}
       <div class="page-header">
   -        <h1>{{ 'title.homepage'|trans|raw }}</h1>
   +        <h1>Welcome to the Upsun Demo</h1>
       </div>
   
       <div class="row">

3. Add and commit your changes:

   Terminal

   git commit -a -m "Update text"

4. Deploy your changes to the feat-a environment:

   Terminal

   symfony upsun:deploy

   Note that each environment has its own domain name. To view the domain name of your new environment, run the following command:

   Terminal

   symfony upsun:url --primary

5. Iterate by changing the code, committing, and deploying. When satisfied with your changes, merge them to the main branch, deploy, and remove the feature branch:

   Terminal

   git checkout main
   git merge feat-a
   symfony environment:delete feat-a
   git branch -d feat-a
   symfony upsun:deploy

   Note that deploying to production is fast because the image built for the feat-a environment is reused.

   For a long running branch, keep the code up-to-date with the main branch by using git merge main or git rebase main. Also, keep the data in sync with the production environment by using symfony upsun:env:sync.

5. Optional: Use a third-party Git provider

When you choose to use a third-party Git hosting service, the Upsun Git repository becomes a read-only mirror of the third-party repository. All your changes take place in the third-party repository.

Add an integration to your existing third-party repository:

• BitBucket
• GitHub
• GitLab

Back Symfony integration