Files @ 0e42ac1a358b
Branch filter:

Location: kallithea/docs/usage/debugging.rst

0e42ac1a358b 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw
Mads Kiilerich
helpers: replace webhelpers.flash with own implementation

webhelpers is dead.

One small function implements pretty much the same functionality, using the
same session key so tests still pass, but also very simple and without external
dependencies.

It could be implemented with a class and different methods for adding, getting
and clearing. But internally, it would probably have pretty much the same
helper function has here. So let's just avoid the unnecessary complexity and
keep it simple.
.. _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.