kallithea Files · docs/usage/debugging.rst

Files @ b302d4254bd0

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

setup: bump some setup.py dependency versions

Upgrade notes for these libraries have not been investigated thoroughly, but
testing seems to show that it works. We are also early in the development
phase, so big problems will be caught by general testing before going wide.

Note: TurboGears2 is not upgraded to 2.4 yet. That upgrade would require us to
first move away from using the Pylons compatibility layer.

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