kallithea Files · docs/usage/debugging.rst

Files @ 7c952ea3d7b3

Branch filter:

Location: kallithea/docs/usage/debugging.rst

7c952ea3d7b3 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

docs/installation: clarify and reorder alternative installation methods

- Add an introduction describing the different installation methods and their
pros/cons.

- Clarify that Python 3.x is not currently supported.

- Move standard pip install method as last method, and rename as also in
virtualenv we are installing from Python Package Index.

.. _debugging:

===================
Debugging Kallithea
===================

If you encountered problems with Kallithea here are some instructions how to
possibly debug them.

** First make sure you're using the latest version available.**

Enable detailed debug
---------------------

Kallithea uses standard python logging modules to log it's output.
By default only loggers with INFO level are displayed. To enable full output
change `level = DEBUG` for all logging handlers in currently used .ini file.
This change will allow to see much more detailed output in the logfile 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
.ini file, this will trigger and interactive debugger each time there an
error in browser, or send a http link if error occured in the backend. This
is a great tool for fast debugging as you get a handy python console right
in the web view. ** NEVER ENABLE THIS ON PRODUCTION ** the interactive console
can be a serious security threat to you system.