kallithea Files · docs/usage/debugging.rst

Files @ 37ac2ac0a9ae

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

scripts/validate-commits: use direct /bin/bash interpreter

Use of '#!/bin/bash' vs '#!/usr/bin/env bash' can be argued multiple ways.
For example, see:
https://stackoverflow.com/questions/21612980/why-is-usr-bin-env-bash-superior-to-bin-bash/21613039

It seems to be more common to use the first approach. And we don't have a
specific reason to prefer the latter. Moreover, other scripts in this repo,
like 'make-release' and 'whitespacecleanup.sh' use the former too.

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