kallithea Files · docs/usage/debugging.rst

Files @ 588c556aa00b

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Søren Løvborg

comments: for PR comments, link directly to comment on PR page

Comments with approval changes made in the context of PRs also show up
on the individual PR changesets, and currently link to the (top of the)
PR page. If the user wants to see the surrounding comments, it can be
difficult to find the comment.

This change makes the link go to the comment anchor on the PR page, so
the user immediately sees the relevant comment thread. The PR metadata
is still readily available (by scrolling up or pressing "Home").

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