kallithea Files · docs/usage/debugging.rst

Files @ b97ba9b23796

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

helpers: introduce render_w_mentions

Eventually this function should support and auto detect multiple formats and is
thus not named for a specific format. But for now it is plain text only.

This kind of markup can quite easily and safely support additional magic
markup. It is much harder to do that on top of a richer markup format; it
must essentially be done in a single pass, with both all the various regexps
and the rst formatting done in a single pass.

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