Skip to content

Commit

Permalink
Add some troubleshooting steps.
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed May 9, 2021
1 parent 06aa63c commit d8a5552
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,18 @@ $this->addPlugin('DebugKit');
```
* Set `'debug' => true,` in `config/app.php`.

## Is DebugKit not working?

If you don't see a CakePHP icon on the bottom right of your page DebugKit is not be
working correctly. Some common problems are:

1. Your PHP environment doesn't have SQLite installed. Check your application
logs to confirm if this happening. You can either configure DebugKit to use
a different database, or install the PDO SQLite 3 extension.
2. Your hostname needs to be added to the `DebugKit.safeTld`. If your local
domain isn't a known development environment name, DebugKit will disable
itself to protect a potentially non-development environment.

## Reporting Issues

If you have a problem with DebugKit please open an issue on [GitHub](https://github.com/cakephp/debug_kit/issues).
Expand Down

0 comments on commit d8a5552

Please sign in to comment.