Files @ 70e29dc91deb
Branch filter:

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

70e29dc91deb 1.1 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Thomas De Schampheleire
ini file: clarify that beaker.session.key should be unique

When several instances of Kallithea are running on the same machine, the
same browser cannot be logged into both instances at the same time without
conflicts. The login session are saved into the same cookie; logging into
one instance closes the session on the second instance and vice-versa.

This is caused because the cookie name is simply 'kallithea', combined with
the fact that the cookie specification (RFC6265) states that there is no
isolation of cookies based on port. This means that the browser sends all
cookies from a given domain with all services (Kallithea instances) running
on that domain, irrespective of port.

The services thus need to handle any such issue themselves, for example by
using unique cookie names and only interacting with one's own cookie.

Making the key unique when creating the configuration file proved difficult:
- it does not seem possible to hook into 'paster make-config'
- since Beaker directly interprets the beaker.session.key, changing it on
the fly from SessionMiddleware will not work correctly.

There is a kallithea-config script that is an alternative to 'paster
make-config' which would be the ideal place to make such changes. However,
it seems this method is not advocated over 'paster make-config' (yet?).

Instead, simply add a comment in the config file and let the user take care
of it.
.. _debugging:

===================
Debugging Kallithea
===================

If you encountered problems with Kallithea here are some instructions how to
possibly debug them.

** First make sure you're using the latest version available.**

Enable detailed debug
---------------------

Kallithea uses standard python logging modules to log it's output.
By default only loggers with INFO level are displayed. To enable full output
change `level = DEBUG` for all logging handlers in currently used .ini file.
This change will allow to see much more detailed output in the logfile 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
.ini file, this will trigger and interactive debugger each time there an
error in browser, or send a http link if 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. ** NEVER ENABLE THIS ON PRODUCTION ** the interactive console
can be a serious security threat to you system.