Support

Documentation

4.Debug mode

4.Debug mode

Kickstart has an optional debug mode. In this mode, it will write a log of the actions it takes while extracting your backup archive into a file named kickstart_debug.php. This log file consists of a simple PHP statement at the top of the file to prevent it from being directly web accessible. The rest of the file is just plain text.

Note

If you want to request support for an archive extraction issue you must enable Kickstart's debug mode. Download the generated kickstart_debug.php file. Change its name to kickstart_debug.txt and delete its first line before trying to upload it to our support ticket system. Files with .php extensions and/or PHP content are rejected by our site.

First, you need to create a configuration file named something.json.php where something is the name of your Kickstart file. If your file is named example.php then the configuration file MUST be named example.json.php. Alternatively, the file can be named kickstart.json.php regardless of the name of your Kickstart file. If both files exist, the configuration file using the same name as your Kickstart file (in our example: example.json.php) will take precedence for security reasons; the kickstart.json.php file will NOT be read in this case.

The contents of this file must be as follows:

<?php die(); ?>{   "debug": 1}

Note

You can combine the debug option with the password option discussed in the Security section. In this case the configuration file's contents look like this:

<?php die(); ?>{   "debug": 1,   "password": "yourpassword"}

Please note that the kickstart_debug.php file is NOT deleted when you click on Clean Up. You have to delete this file yourself. This is intentional. This is a debug log, only used to troubleshoot a suspected extraction issue.