Requirements¶

Before getting started, check that you have Git installed and SSH properly configured as SymfonyCloud relies on both quite heavily. This also means that your project must use Git as its version control system.

Installing the CLI Tool¶

To manage your Symfony projects with SymfonyCloud, install the symfony CLI tool:

1

$ curl -sS https://get.symfony.com/cli/installer | bash

Then, authenticate with your SymfonyConnect credentials:

1

$ symfony login

You are now all set! To get started with the Symfony CLI tool, run symfony to get some common commands or symfony help to list all available commands.

If you want more detailed information about a command, use symfony help COMMAND_NAME, or symfony COMMAND_NAME --help. The second one is useful when you have already added some arguments and/or flags like in symfony something --flag arg --help.

Deploying a Project on SymfonyCloud¶

There are three steps needed to deploy a project on SymfonyCloud:

• Configure the project by describing its infrastructure (including its services);
• Create the project on SymfonyCloud;
• Deploy the project.

If you want to deploy a sample project on SymfonyCloud, create a Symfony Demo project with the following command:

1
2

$ symfony new --demo /path/to/demo
$ cd /path/to/demo

1

$ symfony project:init

1
2

$ git add .symfony.cloud.yaml .symfony/services.yaml .symfony/routes.yaml php.ini
$ git commit -m "Add SymfonyCloud configuration"

1

$ symfony project:create --title=demo --plan=development

1

$ symfony deploy

1

$ symfony var:set --file=.env

1

$ symfony open:remote

Working on a Project¶

Now that the project is deployed, let’s describe a typical scenario where you want to fix a bug or add a new feature.

First, you need to know that the master branch always represents the production environment. Any other branch is for developing new features, fixing bugs, or updating the infrastructure.

Let’s create a new environment (a Git branch) to make some changes, without impacting production:

1
2

$ git checkout master
$ symfony env:create feat-a

This command creates a new local feat-a branch based on the master branch and activate a related environment on SymfonyCloud. If you have some services enabled, the new environment inherits the data of the parent environment (the production one here).

Let’s make some simple visual changes. If you have created a Symfony demo application, edit the templates/default/homepage.html.twig template and make the following change:

1
2
3
4
5
6
7
8

# templates/default/homepage.html.twig
{% block body %}
    <div class="page-header">
-        <h1>{{ 'title.homepage'|trans|raw }}</h1>
+        <h1>Welcome to the SymfonyCloud Demo</h1>
    </div>

    <div class="row">

Commit the change:

1
2

$ git commit -a -m "Update text"
$ # in a real-life scenario, you would push the change to the upstream Git repository

And deploy the change to the feat-a environment:

1
2
3
4
5

# the 'env:create' command checkouts into the new branch automatically,
# but if you changed it for some reason, checkout the 'feat-a' branch again
# $ git checkout feat-a

$ symfony deploy

Browse the new version and notice that the domain name is different now (each environment has its own domain name):

1

$ symfony open:remote

Iterate by changing the code, committing, and deploying. When satisfied with the changes, merge it to master, deploy, and remove the feature branch:

1
2
3
4
5

$ git checkout master
$ git merge feat-a
$ git branch -d feat-a
$ symfony env:delete feat-a
$ symfony deploy

Deleting a project¶

Use symfony project:delete to delete a SymfonyCloud project (optionally specifying the project ID using the --project flag); use symfony projects to list all active projects under your account.