kallithea Files · docs/usage/debugging.rst

Files @ 6e75963503cc

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

admin: auth: make sure list of auth modules is consistent

When authentication modules are enabled, but fail to be enabled e.g. due to
missing dependencies (pam, ldap), the list of enabled plugins still contains
the failing module. However, the 'Enabled/Disabled' button correctly shows
Disabled, causing a mismatch between both.

Worse, the mismatch cannot be corrected by clicking the Enabled/Disabled
button, one needs to manually clear the problematic entry in the list of
enabled plugins.

Fix by always populating the list with the actually enabled plugins, not
those requested by the user in case there are failures.

.. _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.