You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.
Installing & Setting up the Symfony Framework
Installing & Setting up the Symfony Framework¶
Do you prefer video tutorials? Check out the Stellar Development with Symfony screencast series.
Create your new project by running:
$ composer create-project symfony/website-skeleton my-project
This will create a new
my-project directory, download some dependencies into
it and even generate the basic directories and files you'll need to get started.
In other words, your new app is ready!
website-skeleton is optimized for traditional web applications. If
you are building microservices, console applications or APIs, consider
using the much simpler
$ composer create-project symfony/skeleton my-project
Running your Symfony Application¶
If you want to use a virtual machine (VM) with Vagrant, check out Homestead.
Move into your new project and start the server:
$ cd my-project $ symfony server:start
Open your browser and navigate to
http://localhost:8000/. If everything is working,
you'll see a welcome page. Later, when you are finished working, stop the server
Ctrl+C from your terminal.
If you're having any problems running Symfony, your system may be missing some technical requirements. Use the Symfony Requirements Checker tool to make sure your system is set up.
If you're using a VM, you may need to tell the server to bind to all IP addresses:
$ php bin/console server:start 0.0.0.0:8000
You should NEVER listen to all interfaces on a computer that is directly accessible from the Internet.
Storing your Project in git¶
Storing your project in services like GitHub, GitLab and Bitbucket works like with
any other code project! Init a new repository with
Git and you are ready to push
to your remote:
1 2 3
$ git init $ git add . $ git commit -m "Initial commit"
Your project already has a sensible
.gitignore file. And as you install more
packages, a system called Flex will add more lines to
that file when needed.
Setting up an Existing Symfony Project¶
If you're working on an existing Symfony application, you only need to get the project code and install the dependencies with Composer. Assuming your team uses Git, setup your project with the following commands:
1 2 3 4 5 6 7
# clone the project to download its contents $ cd projects/ $ git clone ... # make Composer install the project's dependencies into vendor/ $ cd my-project/ $ composer install
You'll probably also need to customize your .env and do a few other project-specific tasks (e.g. creating database schema). When working on a existing Symfony app for the first time, it may be useful to run this command which displays information about the app:
$ php bin/console about
Checking for Security Vulnerabilities¶
Symfony provides a utility called the "Security Checker" to check whether your project's dependencies contain any known security vulnerability. Check out the integration instructions for the Security Checker to set it up.
The Symfony Demo application¶
The Symfony Demo Application is a fully-functional application that shows the recommended way to develop Symfony applications. It's a great learning tool for Symfony newcomers and its code contains tons of comments and helpful notes.
To check out its code and install it locally, see symfony/symfony-demo.
Go Deeper with Setup¶
- Using Symfony with Homestead/Vagrant
- How to Use PHP's built-in Web Server
- Configuring a Web Server
- Installing Composer
- Upgrading a Third-Party Bundle for a Major Symfony Version
- Setting up or Fixing File Permissions
- Using Symfony Flex to Manage Symfony Applications
- Symfony Local Web Server
- How to Install or Upgrade to the Latest, Unreleased Symfony Version
- Upgrading a Major Version (e.g. 3.4.0 to 4.1.0)
- Upgrading a Minor Version (e.g. 4.0.0 to 4.1.0)
- Upgrading a Patch Version (e.g. 4.1.0 to 4.1.1)
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.