kallithea Files · docs/usage/debugging.rst

Files @ 6353b5e87091

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Mads Kiilerich

ini: specify utf8 for sample MySQL connection strings

By default, the MySQL stack will store unicode as UTF-8 encoded data in string
fields, thus without using any unicode capabilities in the database.

As described in
http://docs.sqlalchemy.org/en/latest/dialects/mysql.html#mysql-unicode , set
charset=utf8 to actually put unicode in the database.

Existing databases that already store utf8 in the database should keep using
the old url.

This will only support 16 bit code points, but utf8mb4 will double the key size
and make them too big for MySQL.

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