kallithea Files · docs/usage/debugging.rst

Files @ fa1d80d31b48

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

error: remove unused Pylons-specific img/style methods

The img and style methods in the error controller are standard Pylons
boilerplate. They are used from the Pylons default error document template.
The purpose of these methods is to serve images and stylesheets from the
Pylons module, rather than having to copy these files into a particular
application installation.

Since Kallithea uses a custom error template with our own styles and images,
these methods are not actually used.

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