Skip to content


Subversion checkout URL

You can clone with
Download ZIP

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.


require_once(dirname(dirname(dirname(__FILE__))) . '/www/examples/header.php');

<h1>Basic Setup: files</h1>

<p>Setup FirePHP the way it is intended to gain maximum configuration freedom.</p>

<p>You can browse the source files for this example on <a target="_blank" href="">github</a> or your system (if installed locally) at <b><?php echo $basePath.'/examples/BasicSetupFiles/'; ?></b>.</p>

<h2>Some assumptions for this example</h2>

    <li>The document root is at: <b><?php echo $basePath; ?></b></li>
    <li>The application root URL is: <b><?php echo $baseURL; ?>/examples/BasicSetupFiles/public/</b> (i.e. The URL to the root of the public pages of this example which we are treating as an application)</li>
    <li>Thus the <a target="_blank" href="">Insight Server Path</a> is: <b>/examples/BasicSetupFiles/public/</b></li>


    <li>Open <i>DeveloperCompanion</i> and click <i>New Workspace</i> (<a target="_blank" href="">detailed instructions</a>)

        <p style="padding: 5px; border: 1px solid #acacac; background-color: #DBFFE6;"><span style="color: #8c8c8c; font-weight: bold;">Homepage URL:</span><b><br/><?php echo $baseURL; ?>/examples/BasicSetupFiles/public/</b></p>

        <p style="padding: 5px; border: 1px solid #acacac; background-color: #DBFFE6;"><span style="color: #8c8c8c; font-weight: bold;">Configure and Include FirePHP in Application:</span><b><br/>Advanced (configuration files)</b></p>

    <li><b>[already done]</b> Copy the generated code into the respective files. (Show: <a target="example-content" href="/www/show-file.php?path=/examples/BasicSetupFiles/package.json">/examples/BasicSetupFiles/package.json</a>, <a target="example-content" href="/www/show-file.php?path=/examples/BasicSetupFiles/credentials.json">/examples/BasicSetupFiles/credentials.json</a>, <a target="example-content" href="/www/show-file.php?path=/examples/BasicSetupFiles/lib/bootstrap.php">/examples/BasicSetupFiles/lib/bootstrap.php</a>)
        <p>NOTE: Typically the <i>authkeys</i> array in <i>credentials.json</i> should include the key provided by <i>DeveloperCompanion</i> in the generated code. Using '*' will allow <b>ALL</b> clients.</p></li>
    <li>Click <i>Add Workspace</i> in <i>DeveloperCompanion</i>.</li>
    <li><a class="browse-example" href="javascript:browseExample('public/index.php')">Browse example</a></li>

<h2>While the example pages are navigated</h2>

        <p>Look for log messages in the <b><a target="_blank" href="">Firebug</a> <a target="_blank" href="">Console</a></b>. You must have <i>Firebug</i> and the <i>Firebug Console</i> and <i>Net</i> panels enabled.</p>
        <p>Look for requests in the <i>Requests</i> table of the <i>Workspace</i> you setup above in the <i>DeveloperCompanion</i> window. Select a request to see detailed information. When done click on the red <i>X</i> next to <i>Request</i> near the top of the window to go back to all requests.</p>

<h2>More Information</h2>

<p>See: <a target="_blank" href=""></a></p>

require_once(dirname(dirname(dirname(__FILE__))) . '/www/examples/footer.php');
Something went wrong with that request. Please try again.