# HG changeset patch # User Thomas De Schampheleire # Date 1428259581 -7200 # Node ID 601282d36c06811382c6032b24a89f0018a051ff # Parent e5ab200892e3c8de4315e4846bf0c67d5a1cf09f docs/usage: generalize 'git support' into 'version control systems support' Rename and rework the 'git support' page such that it can hold information about Mercurial as well. diff -r e5ab200892e3 -r 601282d36c06 docs/index.rst --- a/docs/index.rst Sat Apr 04 21:45:22 2015 +0200 +++ b/docs/index.rst Sun Apr 05 20:46:21 2015 +0200 @@ -27,7 +27,7 @@ :maxdepth: 1 usage/general - usage/git_support + usage/vcs_support usage/performance usage/locking usage/statistics diff -r e5ab200892e3 -r 601282d36c06 docs/usage/git_support.rst --- a/docs/usage/git_support.rst Sat Apr 04 21:45:22 2015 +0200 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,50 +0,0 @@ -.. _git_support: - -=========== -Git support -=========== - - -Kallithea Git support is enabled by default. You just need a Git -command line client installed on the server to make Git work fully. - -Web server with chunked encoding --------------------------------- - -Large Git pushes requires a 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 `paster serve` instead of the built-in `paste` WSGI -server. - -The default paste server 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 = - - -Disabling Git -------------- - -You can always disable Git or Mercurial support by editing the -file ``kallithea/__init__.py`` and commenting out the backend. - -.. code-block:: python - - BACKENDS = { - 'hg': 'Mercurial repository', - #'git': 'Git repository', - } - -.. _waitress: http://pypi.python.org/pypi/waitress -.. _gunicorn: http://pypi.python.org/pypi/gunicorn diff -r e5ab200892e3 -r 601282d36c06 docs/usage/vcs_support.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/usage/vcs_support.rst Sun Apr 05 20:46:21 2015 +0200 @@ -0,0 +1,49 @@ +.. _vcs_support: + +=============================== +Version control systems support +=============================== + +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. + +.. code-block:: python + + BACKENDS = { + 'hg': 'Mercurial repository', + #'git': 'Git repository', + } + +Git support +----------- + +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 `paster serve` instead of the built-in `paste` WSGI +server. + +The default paste server 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 = + + + +.. _waitress: http://pypi.python.org/pypi/waitress +.. _gunicorn: http://pypi.python.org/pypi/gunicorn