Store
Community Documentation

v3 Knowledgebase

Enabling Debug Mode

If you encounter problems on your site, enabling Debug Mode in many cases helps answer the question on what is causing a problem. By default all errors are suppressed so end-users do not see such errors. To enable Debug Mode this can be done either by enabling it from your AdminCP or accessing your web server. If you encounter a problem that does not cause a blank white screen you can enable debug mode from your AdminCP, however if your problem is due to a blank white screen you must enable debug mode by accessing your server and creating a PHP file.

Enabling from AdminCP


To enable debug mode from AdminCP, navigate to your AdminCP and go to...
Settings >> System Settings >> Manage Settings >> Debug
For the setting...
Debug Level
change the value from "Level 0" to any of the other levels.

Enabling from Your Server


To enable debug mode from your server you need to access your site via an FTP client or a hosting file manager. Once you have reached your sites root directory navigate to the folder...
include/setting/
Create a new file:
dev.sett.php
Open the file and add the following:
PHP:
<?php
    
// Log error messages to XML flat file within the cache folder
    
define('PHPFOX_LOG_ERROR'true);

    
// Enable debug
    
define('PHPFOX_DEBUG'true);

    
// Debug level
    
define('PHPFOX_DEBUG_LEVEL'3);

    
// Force browsers to re-cache static files on each page refresh
    
define('PHPFOX_NO_CSS_CACHE'true);
    
define('PHPFOX_DEBUG_EXIT'true);
    
define('PHPFOX_NO_TEMPLATE_CACHE'true);
?>

Save and close the file.

Visit your site to see any errors. Log in to see any errors.

You can also enable debug mode only to a specific IP address, to find out your ip address you can visit a site like this. The IP for this example will be: 192.192.192.192, yours should have a similar format.
Then we wrap the code above into an if:
PHP:
<?php
if ($_SERVER['REMOTE_ADDR'] == '192.192.192.192')
{
define('PHPFOX_DEBUG'true);
}
?>


Save and close the file and that should enable it only for your IP