Files @ b374803eafb6
Branch filter:

Location: kallithea/docs/usage/debugging.rst - annotation

b374803eafb6 1.2 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
domruf
MANIFEST: only include bootstrap from node_modules when packaging or installing

With the 'less' source folder placed under 'public', the whole folder happened
to be fully included in source distribution and installed. *If* 'npm install'
has been run, 'kallithea/public/less/node_modules/' will contain both
build/development tools ('less' and dependencies) and the source of Bootstrap.

We do want Bootstrap source to be included so it automatically gets 'vendored',
but we don't want all the build tools.

We thus prune the whole 'node_modules' directory, but add
'node_modules/bootstrap' back in.

This is exactly what it is. It might seem a bit fragile: There is no
verification that it only is the 'bootstrap' directory that should be added
back in, and there is no verification that it actually is present and included.
.. _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.