kallithea Files · docs/usage/debugging.rst

Files @ ac03ae060ca0

Branch filter:

Location: kallithea/docs/usage/debugging.rst

ac03ae060ca0 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

templates: fix aria markup from 24a0c176a63d

The markup in base.html is a bit misleading. The "quick login" drop down menu
is not just the quick login box but also the "current user info" box.

When the user is logged in, the "real" quick login box isn't shown and the drop
menu's aria-describedby="quick_login_h" thus becomes an invalid reference.

To fix the reference, also call the user info for quick_login_h - that is
approximately correct.

.. _debugging:

===================
Debugging Kallithea
===================

If you encounter problems with Kallithea, here are some instructions
on how to debug them.

.. note:: First make sure you're using the latest version available.


Enable detailed debug
---------------------

Kallithea uses the standard Python ``logging`` module to log its output.
By default only loggers with ``INFO`` level are displayed. To enable full output
change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
This change will allow you to see much more detailed output in the log file or
console. This generally helps a lot to track issues.


Enable interactive debug mode
-----------------------------

To enable interactive debug mode simply comment out ``set debug = false`` in
the .ini file. This will trigger an interactive debugger each time
there is an error in the browser, or send a http link if an error occurred in the backend. This
is a great tool for fast debugging as you get a handy Python console right
in the web view.

.. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
             can be a serious security threat to your system.