kallithea Files · docs/usage/debugging.rst

Files @ e36bc85e3ecb

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Søren Løvborg

db: remove SQLAlchemy Migrate database table

Use Alembic to migrate database away from SQLAlchemy Migrate. This
eliminates the last vestiges of SQLAlchemy Migrate. Since we drop
the Migrate table (and its contents), it is not possible to revert
this database change; however, downgrading to this Alembic schema
revision (9358dc3d6828) will in practice be enough to ensure
compatibility with all previous Kallithea versions.

(As always, the Alembic migration script is committed in the same
revision as the database schema changes.)

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