kallithea Files · docs/usage/debugging.rst

Files @ 3fff45b4c8ed

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

domruf

tests: set EMAIL for Git commit test_push_on_locked_repo_by_other_user_git - it _is_ necessary on some machines

7db1bcf1d95b too aggressively removed setting EMAIL (which was set in a way
that didn't work on Windows).

On some machines the git commit in _add_files_and_push would fail with 'Please
tell me who you are' and the actual test check of "Repository %s locked by
user" would fail.

On other machines - also without any local git configuration - it works fine.

https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#Committing
suggests that it might be a good idea to set it ... so let's do it.

(Patch modified by Mads Kiilerich)

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