Check if your symfony application is ready for deployment

permalink

This is the page displayed in the production environment when symfony catches an error.

Symfony looks for a error.html.php file and let you choose where you prefer to put it:

1. At mySfProject/apps/frontend/config/error/error.html.php

   Useful if you want to have a different version for each application

2. At mySfProject/config/error/error.html.php

   The main configuration folder of your project

If you want, you can grab the original file and modify it.

Display the "Oops! An Error Occurred" page to test it

In an action that works fine, add on top:

throw new Exception('Only for test, don\'t forget to remove it!');

Test the related page in the production environement.

top

permalink

When a user doesn't have the credentials required for an action, symfony tries to access to the default/secure action.

To customize the "Credentials Required" page, add the executeLogin() method in the apps/frontend/modules/default/actions/actions.class.php file:

/**
 * Warning page for restricted area - requires login
 *
 */
public function executeSecure()
{
}

Then create the apps/frontend/modules/default/templates/secureSuccess.php template.

If you want, you can grab the original file and modify it.

Display the "Credentials Required" page to test it

1. Pass in the production environement
2. Login, but not as super admin.

3. In one of your modules, add in apps/frontend/modules/yourModule/config/security.yml:

   all:
     credentials: [ aCredentialYouDontHave ]
   

4. Clear cache
5. Try to access to one of the module actions

Using an other module

If you want to use an other module, modify apps/frontend/config/settings.yml:

all:
  .actions:
    secure_module: foo   # To be called when a user doesn't have
    secure_action: bar   # The credentials required for an action

Clear your cache.

php symfony cc

top

permalink

When a user requests a module declared as disabled in /apps/frontend/modules/mymodule/config/module.yml, symfony tries to access to the default/disabled action.

To customize the "This Module is Unavailable" page, add the executeDisabled() method in the apps/frontend/modules/default/actions/actions.class.php file:

/**
 * Module disabled
 *
 */
public function executeDisabled()
{
}

Then create the apps/frontend/modules/default/templates/disabledSuccess.php template.

If you want, you can grab the original file and modify it.

Display the "This Module is Unavailable" page to test it

1. Pass in the production environement

2. In one of your modules, add in apps/frontend/modules/yourModule/config/module.yml:

   all:
     enabled:     false
   

3. Clear cache
4. Try to access to one of the module actions

If your default module is protected

Make sure to un-secure the disabled action in apps/frontend/modules/default/config/security.yml:

disabled:
  is_secure: off

Using an other module

If you want to use an other module, modify apps/frontend/config/settings.yml:

all:
  .actions:
    module_disabled_module: foo   # To be called when a user requests
    module_disabled_action: bar     # A module disabled in the module.yml

Clear your cache.

php symfony cc

top

permalink

Modern browsers request a favicon.ico file when a user first browses to your application, to represent the application with an icon in the address bar and bookmarks folder.

Providing such a file will not only make your application's look and feel complete, but it will also prevent a lot of 404 errors from appearing in your server logs.

Some useful links :

• An empty favicon
• A favicon generator
• An other one

top

permalink

The session-handling mechanism uses a cookie on the client side, and this cookie is called "symfony" by default.

In the apps/frontend/config/factories.yml file, add for the all environment:

storage:
  class: sfSessionStorage
  param:
    session_name: my_project

If the sfGuardPlugin is installed, you can modify the "Remember me" cookie name in myProject/config/app.yml:

all:
  sf_guard_plugin:
    remember_cookie_name:   myProjectRememberMe

top

permalink

In the apps/frontend/config/settings.yml file, you can delete the application name from your uri by activing the no_script_name option.

This option is enabled for the first generated application (most often, the frontend), but not for the others.

Why ?

Because without the application name, symfony wouldn't know which one to use when the applications share the same domain.

We have to find an other way to let symfony know which application to use.

A solution can be to use several domains :

• http://my-app.com for the frontend
• http://my-app-backend.com for the backend

Personnally, I prefer use some sub domains for each application :

• http://my-app.com for the frontend
• http://admin.my-app.com for the backend

If your project is hosted on a dedicated server

You juste have to add a new virtual host in httpd.conf :

<VirtualHost *:80>
  ServerName admin.my-app.com
  DirectoryIndex backend.php
  DocumentRoot "/path/to/the/web/directory"
  <Directory "/path/to/the/web/directory">
    AllowOverride All
    Allow from All
  </Directory>
  Alias /sf /path/to/the/symfony/data/web/sf
  <Directory "/path/to/the/symfony/data/web/sf">
    AllowOverride All
    Allow from All
  </Directory>
</VirtualHost>

If your project is hosted on a shared hosting environment

In that case, you probably can't access to the httpd.conf.
So let's play with the /web/.htaccess. Just after :

<IfModule mod_rewrite.c>
  RewriteEngine On

Add the following lines:

# The admin subdomain returns to the backend
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{HTTP_HOST} ^admin\.my-app\..*
RewriteRule ^(.*)$ backend.php [QSA,L]

Now, you can modify settings.yml

prod:
  .settings:
    no_script_name:  true

Don't forget to clear the cache.

php symfony cc

top