kallithea Files · docs/usage/debugging.rst

Files @ f8a714c2c5a1

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

db: make sure all (non-primary) columns have nullable set explicitly

The default of nullable=True is rarely good for us so nullable should always be
specified unless there is a reason to allow nullable ... and if the default is
fine, xplicit is better than implicit.

The declared nulliness of some fields are changed where it seems like code
already enforced it.

Some fields are marked as FIXME when they need (trivial?) data conversion to
convert NULLs to default values.

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