kallithea Files · docs/usage/debugging.rst

Files @ e40122629a01

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

rcext: this command actually *does* require a config file ... but doesn't require db configuration

'gearbox make-rcext' would fail when trying to do config['here'] without
initializing the configuration.

The command would work if we gave it a whole db session, but it is more correct
to only require the configuration if that is all it need. The command will
however still fail, as the configuration isn't passed on to tg.config .

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