How to Override Symfony's default Directory Structure
Edit this pageWarning: You are browsing the documentation for Symfony 4.1, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
How to Override Symfony's default Directory Structure
Symfony automatically ships with a default directory structure. You can override this directory structure to create your own. The default directory structure is:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
your-project/
├─ assets/
├─ bin/
│ └─ console
├─ config/
├─ public/
│ └─ index.php
├─ src/
│ └─ ...
├─ templates/
├─ tests/
├─ translations/
├─ var/
│ ├─ cache/
│ ├─ log/
│ └─ ...
└─ vendor/Override the cache Directory
You can change the default cache directory by overriding the getCacheDir()
method in the Kernel class of your application:
1 2 3 4 5 6 7 8 9 10 11 12
// src/Kernel.php
// ...
class Kernel extends BaseKernel
{
// ...
public function getCacheDir()
{
return dirname(__DIR__).'/var/'.$this->environment.'/cache';
}
}In this code, $this->environment is the current environment (i.e. dev).
In this case you have changed the location of the cache directory to
var/{environment}/cache.
Caution
You should keep the cache directory different for each environment,
otherwise some unexpected behavior may happen. Each environment generates
its own cached configuration files, and so each needs its own directory to
store those cache files.
Override the logs Directory
Overriding the logs directory is the same as overriding the cache
directory. The only difference is that you need to override the getLogDir()
method:
1 2 3 4 5 6 7 8 9 10 11 12
// src/Kernel.php
// ...
class Kernel extends Kernel
{
// ...
public function getLogDir()
{
return dirname(__DIR__).'/var/'.$this->environment.'/log';
}
}Here you have changed the location of the directory to var/{environment}/log.
Override the Templates Directory
If your templates are not stored in the default templates/ directory, use
the twig.paths configuration option to define your
own templates directory (or directories):
1 2 3 4
# config/packages/twig.yaml
twig:
# ...
paths: ["%kernel.project_dir%/resources/views"]Override the Translations Directory
If your translation files are not stored in the default translations/
directory, use the framework.translator.paths
configuration option to define your own translations directory (or directories):
1 2 3 4 5
# config/packages/translation.yaml
framework:
translator:
# ...
paths: ["%kernel.project_dir%/i18n"]Override the public Directory
If you need to rename or move your public directory, the only thing you need
to guarantee is that the path to the var directory is still correct in your
index.php front controller. If you simply renamed the directory, you're
fine. But if you moved it in some way, you may need to modify these paths inside
those files:
1
require_once __DIR__.'/../path/to/vendor/autoload.php';You also need to change the extra.public-dir option in the
composer.json file:
1 2 3 4 5 6 7
{
"...": "...",
"extra": {
"...": "...",
"public-dir": "my_new_public_dir"
}
}Tip
Some shared hosts have a public_html web directory root. Renaming
your web directory from public to public_html is one way to make
your Symfony project work on your shared host. Another way is to deploy
your application to a directory outside of your web root, delete your
public_html directory, and then replace it with a symbolic link to
the public dir in your project.
Override the vendor Directory
To override the vendor directory, you need to define the vendor-dir
option in your composer.json file like this:
1 2 3 4 5 6
{
"config": {
"bin-dir": "bin",
"vendor-dir": "/some/dir/vendor"
},
}Tip
This modification can be of interest if you are working in a virtual environment and cannot use NFS - for example, if you're running a Symfony application using Vagrant/VirtualBox in a guest operating system.
