Files @ 953047e8c88a
Branch filter:

Location: kallithea/docs/administrator_guide/vcs_setup.rst - annotation

953047e8c88a 1.7 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Thomas De Schampheleire
setup: restrict TurboGears2 version to 2.3.x

In TurboGears2 2.3.12, the latest version in the 2.3.x range, the WebOb
dependency requirement is [1]
WebOb >= 1.2, < 1.8.0

In TurboGears2 2.4.0 (which is in pre-release state at the time of this
commit), this becomes [2]:
WebOb >= 1.8.0, < 1.10.0

In the Kallithea dependency list, we have matched our WebOb version
requirements to that of TurboGears2 and use:
WebOb >= 1.7, < 1.8

while our TurboGears2 requirement was liberal and accepted anything in the
2.x range:
TurboGears2 >= 2.3.10, < 3

To avoid new Kallithea installations failing with conflicting WebOb version
requirements after TurboGears2 2.4.0 is released, restrict the version of
TurboGears2 to 2.3.x on the stable branch.

For the default branch, the update to TurboGears2 2.4.0 can be considered
once it's released.

[1] https://github.com/TurboGears/tg2/blob/tg2.3.12/setup.py#L54
[2] https://github.com/TurboGears/tg2/blob/ed89788c3f5dab5a182a938543c9ee4ec14dd7ef/setup.py#L41
.. _vcs_setup:

=============================
Version control systems setup
=============================

Kallithea supports Git and Mercurial repositories out-of-the-box.
For Git, you do need the ``git`` command line client installed on the server.

You can always disable Git or Mercurial support by editing the
file ``kallithea/__init__.py`` and commenting out the backend. For example, to
disable Git but keep Mercurial enabled:

.. code-block:: python

   BACKENDS = {
       'hg': 'Mercurial repository',
       #'git': 'Git repository',
   }


Git-specific setup
------------------


Web server with chunked encoding
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Large Git pushes require an HTTP server with support for
chunked encoding for POST. The Python web servers waitress_ and
gunicorn_ (Linux only) can be used. By default, Kallithea uses
waitress_ for `gearbox serve` instead of the built-in `paste` WSGI
server.

The web server used by gearbox is controlled in the .ini file::

    use = egg:waitress#main

or::

    use = egg:gunicorn#main

Also make sure to comment out the following options::

    threadpool_workers =
    threadpool_max_requests =
    use_threadpool =

Increasing Git HTTP POST buffer size
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If Git pushes fail with HTTP error code 411 (Length Required), you may need to
increase the Git HTTP POST buffer. Run the following command as the user that
runs Kallithea to set a global Git variable to this effect::

    git config --global http.postBuffer 524288000


.. _waitress: http://pypi.python.org/pypi/waitress
.. _gunicorn: http://pypi.python.org/pypi/gunicorn
.. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/