Files @ 7433775cc53b
Branch filter:

Location: kallithea/docs/usage/debugging.rst - annotation

7433775cc53b 1.2 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Mads Kiilerich
page: minimal change to move from webhelpers.paginate to paginate

webhelpers is dead and doesn't work with py3. paginate is not very actively
maintained, but it is the natural successor to webhelpers.paginate, it seems
stable, and it works with py3.

This is a minimal change that seems to work. It preserves existing tech debt
... and adds a little bit more. It will be cleaned up next.

webhelpers.paginate had built-in SqlAlchemy support - now we have to handle it
explicitly.
.. _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.