kallithea Files · docs/usage/debugging.rst

Files @ 6df08d78f8e7

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

cli: fill in git_hook_interpreter at 'config-create' time to really fix potentially invalid interpreter in git hooks (Issue #333)

When generating a configuration file using 'kallithea-cli config-create', it is
probably using the right Python interpreter, so fill in the current Python
executable as 'git_hook_interpreter' in the generated file.

There should thus rarely be any need to configure this manually, and issue #333
will *really* be fixed.

As this causes an absolute path to be encoded inside the ini file, moving
the virtualenv will require updating this path.

For development.ini we do not want to hardcode any path and are happy to leave
it using the old heuristics at runtime.

Suggested-by: Mads Kiilerich <mads@kiilerich.com>

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