kallithea Files · docs/usage/debugging.rst

Files @ 10ee27bae2ff

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

HTML email templates: Outlook: fix width and height attributes to preserve whitespace

The rendering of HTML emails in Outlook is very restricted and based on old
Internet Explorer versions (more or less the same rendering as in Microsoft
Word). To make the Kallithea emails look the same as in the browser, some
adaptations are needed.

HTML width and height attributes do not have any effect, the size is
interpreted as 0px. A CSS-based width and height do work in Outlook and
result in the expected spacing between and within elements of the email.

For Outlook rendering, the CSS variant is probably sufficient, but as it is
unclear how other mail agents will interpret this, leave the HTML width and
height attributes as well.

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