https://github.com/plone/plone.app.debugtoolbar

Debug toolbar for Plone
https://github.com/plone/plone.app.debugtoolbar

Last synced: about 1 month ago
JSON representation

Debug toolbar for Plone

• Host: GitHub
• URL: https://github.com/plone/plone.app.debugtoolbar
• Owner: plone
• Created: 2011-11-07T21:00:22.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-05-10T07:52:09.000Z (7 months ago)
• Last Synced: 2024-07-22T22:19:49.996Z (5 months ago)
• Language: Python
• Homepage:
• Size: 217 KB
• Stars: 8
• Watchers: 161
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Contributing: CONTRIBUTING.rst

Awesome Lists containing this project

• awesome-plone - plone.app.debugtoolbar - A toolbar that shows a wealth of debug information about a running Plone site and the content you are inspecting. Also includes a interactive python-shell, a TALES-expression evaluator and and code-reload. (Develop)

README

        
Introduction

============

``plone.app.debugtoolbar`` provides a wealth of debug information about a

running Plone site at your fingertips.

Translations

============

This product has been translated into

- Italian (thanks, Giacomo Spettoli)

- Spanish (thanks, Leonardo J. Caballero G.)

Installation

============

Simply install it in your build (e.g. by adding it to the ``eggs`` list in your Buildout):

::

    [buildout]

    ...

    eggs =

        plone.app.debugtoolbar

and re-running the ``bin/buildout`` command and install it into your Plone site.

You should now see a ``Debug`` link at the top of your site. Click it to open

the debug drawer. Click on a panel to view relevant information.

Panels include:

* Context, showing information about the current content object

* Interactive, providing an interactive Python prompt through which you can

  interact with the current context (only available to users with the

  ``Manage portal`` permission)

* Request, showing information about the request that produced the current page

* Response, showing information about the response that produced the current

  page

* Published, showing information about the page template or view that was

  published

* Theme, showing information about the current theme and browser layers

* User, showing information about the current user

* Workflow, showing information about workflow and security

* Zope, showing information about how the Zope server is configured

* Versions, listing the versions of every package known to the Zope process

Safety

======

The debug toolbar provides a lot of information about your Plone site that you

may not want the world to know. It could also have a noticeable performance

impact, and for users with the ``Manage portal`` permission it provides access

to an interactive interpreter where arbitrary Python statements can be executed,

allowing a user to bypass Zope security.

In other words: **Do not install this package on your production server**.

Integration

===========

Each panels is included as a viewlet. You can register new panels using a

viewlet registration like this:

::

    

See ``plone.app.debugtoolbar.browser`` for plenty of examples of panels.

Contribute

----------

- Issue Tracker: https://github.com/plone/plone.app.debugtoolbar/issues

- Source Code: https://github.com/plone/plone.app.debugtoolbar

- Documentation: https://github.com/plone/plone.app.debugtoolbar/blob/master/README.rst

License

-------

The project is licensed under the GPLv2.