kallithea Files · docs/usage/debugging.rst

Files @ ff6c3e285166

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

mads

venv: limit pip version to stay below 24.1

Latest pip version pip fail:
WARNING: Ignoring version 5.0.5 of celery since it has invalid metadata:
Requested celery<5.1,>=5 from .../celery-5.0.5-py3-none-any.whl (from Kallithea==0.7.0) has invalid metadata: Expected matching RIGHT_PARENTHESIS for LEFT_PARENTHESIS, after version specifier
pytz (>dev)
~^
Please use pip<24.1 if you need to use this version.

We already use setuptools<67 for the same reason.

Pip will keep noting that a newer pip version is available. Resist the
temptation to upgrade.

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