Symfony is a PHP framework for web projects.
# Getting Started
Before you get started with this recipe we assume that you have:
- Installed Lando and gotten familar with its basics
- Initialized a Landofile for your codebase for use with this recipe
- Read about the various services, tooling, events and routing Lando offers.
However, because you are a developer and developers never ever RTFM (opens new window) you can also run the following commands to try out this recipe with a vanilla install of Symfony.
# Initialize a symfony recipe lando init \ --source cwd \ --recipe symfony \ --webroot public \ --name my-first-symfony-app # Install symfony lando composer create-project symfony/website-skeleton tmp && cp -r tmp/. . && rm -rf tmp # Install other Symfony dependencies you may like lando composer require annotations asset doctrine encore form logger maker profiler security security-guard stof/doctrine-extensions-bundle twig validator var-dumper # Start it up lando start # List information about this app. lando info # Run bin/console commands with: lando console # Here is how to clear cache; lando console cache:clear
Here are the configuration options, set to the default values, for this recipe. If you are unsure about where this goes or what this means we highly recommend scanning the recipes documentation to get a good handle on how the magicks work.
recipe: symfony config: php: '7.4' via: apache:2.4 webroot: . database: mysql:5.7 cache: none xdebug: false config: database: SEE BELOW php: SEE BELOW server: SEE BELOW vhosts: SEE BELOW
Note that if the above config options are not enough all Lando recipes can be further extended and overriden.
# Choosing a php version
You can set
php to any version that is available in our php service. However, you should consult the Symfony requirements (opens new window) to make sure that version is actually supported by Symfony itself.
Here is the recipe config to set the Symfony recipe to use
recipe: symfony config: php: '7.3'
# Choosing a web server
By default this recipe will be served by the default version of our apache service but you can also switch this to use
nginx. We highly recommend you check out both the apache and nginx services before you change the default
# With Apache (default)
recipe: symfony config: via: apache
# With nginx
recipe: symfony config: via: nginx
# Choosing a database backend
By default, this recipe will use the default version of our mysql service as the database backend but you can also switch this to use
mariadb or 'postgres' instead. Note that you can also specify a version as long as it is a version available for use with lando for either
# Using MySQL (default)
recipe: symfony config: database: mysql
# Using MariaDB
recipe: symfony config: database: mariadb
# Using Postgres
recipe: symfony config: database: postgres
# Using a custom version
recipe: symfony config: database: postgres:14
# Choosing a caching backend
By default this recipe will not spin up a caching backend.
However, you can specify one using the
cache recipe config and setting it to use either our use
memcached service. Note that you can optionally/additionally specify a particular version for either as long as it is a version documented as available for use with lando for either service.
# Using redis (recommended)
recipe: symfony config: cache: redis
# Using Memcached
recipe: symfony config: cache: memcached
# Using a custom version
recipe: symfony config: cache: redis:2.8
# Using xdebug
recipe: symfony config: xdebug: true|false
However, for more information we recommend you consult the php service documentation.
# Using custom config files
You may need to override our default Symfony config (opens new window) with your own.
If you do this you must use files that exists inside your applicaton and express them relative to your project root as below.
Note that the default files may change based on how you set both
via. Also note that the
server config will be either for
nginx depending on how you set
via. We highly recommend you check out both the apache and nginx if you plan to use a custom
# A hypothetical project
Note that you can put your configuration files anywhere inside your application directory. We use a
config directory in the below example but you can call it whatever you want such as
./ |-- config |-- default.conf |-- my-custom.cnf |-- php.ini |-- server.conf |-- index.php |-- .lando.yml
# Landofile using custom symfony config
recipe: symfony config: config: database: config/my-custom.cnf php: config/php.ini server: config/server.conf vhosts: config/default.conf
# Environment File
By default, Symfony comes with a
.env configuration file. You will want to modify the following
.env key so that it makes sense for use with Lando.
Here is what that file would look like if you installed symfony as above. Note that your file might be slightly different depending on your configuration.
# In all environments, the following files are loaded if they exist, # the later 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. # # DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES. # # Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2). # https://symfony.com/doc/current/best_practices/configuration.html#infrastructure-related-configuration ###> symfony/framework-bundle ### APP_ENV=dev APP_SECRET=7045ca855d01cf6b008c6744bff58916 #TRUSTED_PROXIES=127.0.0.1,127.0.0.2 #TRUSTED_HOSTS='^localhost|example\.com$' ###< symfony/framework-bundle ### ###> doctrine/doctrine-bundle ### # Format described at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url # For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db" # Configure your db driver and server_version in config/packages/doctrine.yaml DATABASE_URL=mysql://symfony:symfony@database/symfony ###< doctrine/doctrine-bundle ### ###> symfony/swiftmailer-bundle ### # For Gmail as a transport, use: "gmail://username:password@localhost" # For a generic SMTP server, use: "smtp://localhost:25?encryption=&auth_mode=" # Delivery is disabled by default via "null://localhost" MAILER_URL=null://localhost ###< symfony/swiftmailer-bundle ###
# Connecting to your database and/or cache
Lando will automatically set up a database with a user and password and also set an environment variables called
LANDO INFO that contains useful information about how your application can access other Lando services.
Here are is the default database connection information for a Symfony site. Note that the
host is not
database: symfony username: symfony password: symfony host: database # for mysql port: 3306 # for postgres # port: 5432
If you've also specified a caching backend here are the default connection settings.
host: cache # Redis port: 6379 # Memcache port: 11211
You can get also get the above information, and more, by using the
lando info command.
# Importing Your Database
Once you've started up your Symfony site you will need to pull in your database and files before you can really start to dev all the dev. Pulling your files is as easy as downloading an archive and extracting it to the correct location. Importing a database can be done using our helpful
lando db-import command.
# Grab your database dump curl -fsSL -o database.sql.gz "https://url.to.my.db/database.sql.gz" # Import the database # NOTE: db-import can handle uncompressed, gzipped or zipped files # Due to restrictions in how Docker handles file sharing your database # dump MUST exist somewhere inside of your app directory. lando db-import database.sql.gz
You can learn more about the
db-import command over here
By default each Lando Symfony recipe will also ship with helpful dev utilities.
This means you can use things like
php via Lando and avoid mucking up your actual computer trying to manage
php versions and tooling.
lando composer Runs composer commands lando console Runs console commands lando db-export [file] Exports database from a service into a file lando db-import <file> Imports a dump file into database service lando mysql Drops into a MySQL shell on a database service lando php Runs php commands
# Usage examples
# Do a basic cache clear lando console cache:clear # Run composer install lando composer install # Drop into a mysql shell lando mysql # Check the app's php version lando php -v
You can also run
lando from inside your app directory for a complete list of commands which is always advisable as your list of commands may not 100% be the same as the above. For example if you set
database: postgres you will get
lando psql instead of