kallithea Files · docs/usage/debugging.rst

Files @ a45113998d07

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Søren Løvborg

AuthSettingsController: assume 'auth_plugins' option exists

In formglobals, the provided 'auth_plugins' default value is always
replaced with the real database value, returned along with other
plugin settings by Setting.get_auth_settings.

We can safely assume that the database value exists, since not only does
db_manage initialize the 'auth_plugins' option upon database creation,
but other authentication modules already assume its existence.

For instance, Settings.get_auth_plugins() is equivalent to

Settings.get_auth_settings()['auth_plugins']

except that get_auth_plugins will throw AttributeError, not KeyError,
if the 'auth_plugins' key does not exist in the database.

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