Debug Menu

From Cerberus Helpdesk Wiki

Jump to: navigation, search

For the uninitiated, every copy of Cerb4 has an extra area for basic troubleshooting. The table of contents is accessed by visiting a URL similar to the following in your browser:

Access the debug menu via a special webpage.

Simply tack on /index.php/debug or /debug (.htaccess users only) to the end of your root Cerb4 URL, and the page should load up.

Three tools (links) to choose from.

As you can see it’s a very short list of tools, so let’s go over them one by one.

Contents

Requirements Checker

If you (unintentionally) modify your PHP environment, you may need this again.

You probably won’t need to worry about this one after you get the install working, since the prerequisites page just double checks if your server environment is capable of running Cerb4. On the other hand, it's remotely possible your PHP settings were tweaked during a server update. If you're having strange problems, check here to see if you’re unexpectedly missing a few mandatory PHP extensions.

As far as I know this page is identical in function to the first page of the installer, and is also available as a separate file on the wiki page explaining how to install Cerb4.

In any case it’s duplicated at /debug/check for your reference.

phpinfo()

List of your PHP configurations all in one place.

Creating a phpinfo page is something you should be familiar with if you’ve ever dabbled in PHP or possibly configured your own web server. Cerb4 has its own too for reviewing any of your current PHP settings.

To access it append /debug/phpinfo to your URL.

Debug Report (for technical support)

Your Cerb4 settings all neatly formatted.

The one we’ve put off talking about until last, is probably the most valuable. As the title implies this is what the Cerb4 team is going to be interested in when helping you out. You can see that there’s all kinds of information on your Helpdesk install which we can use to spot possible issues. Everything from verifying your Unix permissions are giving proper read/write access to key directories, to whether or not you have set your PHP memory and file limits high enough to accept larger attachments.

With that said, I wouldn’t recommend you forward this data to us every time you write in for support. However if we request it, because it’s a block of plain text, you can easily copy & paste the information into your e-mail.

Since the ‘Debug Report’ is the one you want to keep handy in a pinch, try to remember it’s always available at /debug/report .

Troubleshooting

Similar to the error you can get updating the Helpdesk, you may see this when accessing the debug menu for the first time.

Your IP address (127.0.0.1) is not authorized to debug this helpdesk. Your administrator needs to authorize your IP in Helpdesk Setup or in the framework.config.php file under AUTHORIZED_IPS_DEFAULTS.

As usual, one way you can fix the problem is by logging into your Helpdesk as an administrator, clicking over to ‘helpdesk setup’, ‘System’ tab, and adding the IP address from the error message to the ‘IP Security’ section.


Adapted from a Cerb4 blog post and contributions from Robert M.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox