kallithea Files · docs/usage/debugging.rst

Files @ df275f701d53

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

git: exit early if Git is found but too old (Issue #342)

The warning in the logs were too easy to miss.

It is still OK if git isn't found at all... for example if git_path
configuration doesn't point at something that looks like git.

The git_path configuration already had no default, so just make the code path
for that case more clean. (An easy next/alternative step could be to remove git
from BACKENDS if it isn't configured ...)

The system exit is similar to what is done in 0e33880b2897 ... even though
exiting from from a library might be a bit worse ...

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