kallithea Files · docs/usage/debugging.rst

Files @ 335f7f13b934

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

mads

tests: try harder to prevent Git from reading external configuration

Tests would fail if ~/.gitconfig contained for example:

[init]
defaultBranch = main

Setting GIT_CONFIG_GLOBAL=/dev/null prevents Git from reading ~/.gitconfig ...
but isn't support by Dulwich and doesn't solve the problem.

We will thus work around this issue by setting HOME to the temp test location.
That will prevent Dulwich from reading configuration files by making
os.path.expanduser point to a location with known content.

We also set XDG_CONFIG_HOME to avoid reading ~/.config/git/config .

Setting GIT_CONFIG_NOSYSTEM will prevent reading /etc/gitconfig - that seems
like a good idea too.

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