Files @ 67e561f832b2
Branch filter:

Location: kallithea/docs/usage/debugging.rst - annotation

67e561f832b2 1.2 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Thomas De Schampheleire
email templates: align word to indicate branches: at / branch

Some email templates use '<repo> at <branch>' while others use
'<repo> branch <branch>'. Interestingly even some txt templates use one and
the corresponding HTML template uses the other.

This commit aligns all uses of 'at' and 'branch' to 'branch' as it is
considered more expressive.
The other choice would also be possible, as long as all users are
aligned.
.. _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.