Installing & Setting up the Symfony Framework

Creating Symfony Applications

Symfony provides a dedicated application called the Symfony Installer to ease the creation of Symfony applications. This installer is a PHP 5.4 compatible executable that needs to be installed on your system only once:

Linux and macOS systems:

1
2
3

$ sudo mkdir -p /usr/local/bin
$ sudo curl -LsS https://symfony.com/installer -o /usr/local/bin/symfony
$ sudo chmod a+x /usr/local/bin/symfony

Windows systems:

1

> php -r "file_put_contents('symfony', file_get_contents('https://symfony.com/installer'));"

1
2
3
4
5
6
7
8
9
10
11
12
13

# for example, if WAMP is used ...
> move symfony c:\wamp\bin\php
# create symfony.bat in the same folder
> cd c:\wamp\bin\php
> (echo @ECHO OFF & echo php "%~dp0symfony" %*) > symfony.bat
# ... then, execute the command as:
> symfony

# moving it to your projects folder ...
> move symfony c:\projects
# ... then, execute the command as
> cd projects
> php symfony

Once the Symfony Installer is installed, create your first Symfony application with the new command:

1

$ symfony new my_project_name 3.4

This command creates a new directory called my_project_name/ that contains an empty project based on the most recent stable Symfony version available. In addition, the installer checks if your system meets the technical requirements to execute Symfony applications. If not, you'll see the list of changes needed to meet those requirements.

1
2
3
4
5
6
7
8
9

# use the most recent version in any Symfony branch
$ symfony new my_project_name 3.3
$ symfony new my_project_name 3.4

# use the most recent 'lts' version (Long Term Support version)
$ symfony new my_project_name lts

# use the 'next' Symfony version to be released (still in development)
$ symfony new my_project_name next

Creating Symfony Applications with Composer

If you can't use the Symfony installer for any reason, you can create Symfony applications with Composer, the dependency manager used by modern PHP applications.

If you don't have Composer installed in your computer, start by installing Composer. Then, execute the create-project command to create a new Symfony application based on its latest stable version:

1

$ composer create-project symfony/framework-standard-edition my_project_name

You can also install any other Symfony version by passing a second argument to the create-project command:

1

$ composer create-project symfony/framework-standard-edition my_project_name "2.8.*"

Running the Symfony Application

On production servers, Symfony applications use web servers such as Apache or nginx (see configuring a web server to run Symfony). However, on your local development machine you can also use the web server provided by Symfony, which in turn uses the built-in web server provided by PHP.

First, install the Symfony Web Server and then, execute this command:

1
2

$ cd my_project_name/
$ php bin/console server:run

Open your browser and access the http://localhost:8000/ URL to see the Welcome Page of Symfony:

If you see a blank page or an error page instead of the Welcome Page, there is a directory permission misconfiguration. The solution to this problem is explained in the Setting up or Fixing File Permissions.

When you are finished working on your Symfony application, stop the server by pressing Ctrl+C from the terminal or command console.

Checking Symfony Application Configuration and Setup

The Symfony Installer checks if your system is ready to run Symfony applications. However, the PHP configuration for the command console can be different from the PHP web configuration. For that reason, Symfony provides a visual configuration checker. Access the following URL to check your configuration and fix any issue before moving on:

1

http://localhost:8000/config.php

Fixing Permissions Problems

If you have any file permission errors or see a white screen, then read Setting up or Fixing File Permissions for more information.

Updating Symfony Applications

At this point, you've created a fully-functional Symfony application! Every Symfony app depends on a number of third-party libraries stored in the vendor/ directory and managed by Composer.

Updating those libraries frequently is a good practice to prevent bugs and security vulnerabilities. Execute the update Composer command to update them all at once (this can take up to several minutes to complete depending on the complexity of your project):

1
2

$ cd my_project_name/
$ composer update

1

$ php bin/console security:check

Installing the Symfony Demo or Other Distributions

You've already downloaded the Symfony Standard Edition: the default starting project for all Symfony applications. You'll use this project throughout the documentation to build your application!

Symfony also provides some other projects and starting skeletons that you can use:

The Symfony Demo Application

This is a fully-functional application that shows the recommended way to develop Symfony applications. The app has been conceived as a learning tool for Symfony newcomers and its source code contains tons of comments and helpful notes.

The Symfony CMF Standard Edition

The Symfony CMF is a project that helps make it easier for developers to add CMS functionality to their Symfony applications. This is a starting project containing the Symfony CMF.

The Symfony REST Edition

Shows how to build an application that provides a RESTful API using the FOSRestBundle and several other related Bundles.

1
2
3
4
5
6
7
8
9
10

# clone the project to download its contents
$ cd projects/
$ git clone ...

# make Composer install the project's dependencies into vendor/
$ cd my_project_name/
$ composer install

# now Composer will ask you for the values of any undefined parameter
$ ...

Keep Going!

With setup behind you, it's time to Create your first page in Symfony.

Go Deeper with Setup