Mercurial > kallithea
diff docs/usage/git_support.rst @ 4902:03bbd33bc084
docs: rework stuff
The existing docs were far from how we wanted it to be. There was so much to do
and it is not feasible to do that cleanup it in clean patches.
Instead, I took a sweep through the docs and changed what I thought could
benefit from a change: structure, examples, advices, language, markup, content,
etc.
| author | Mads Kiilerich <madski@unity3d.com> |
|---|---|
| date | Wed, 11 Mar 2015 16:10:30 +0100 |
| parents | e73a69cb98dc |
| children | 326a9336fbe5 |
line wrap: on
line diff
--- a/docs/usage/git_support.rst Wed Mar 11 01:17:33 2015 +0100 +++ b/docs/usage/git_support.rst Wed Mar 11 16:10:30 2015 +0100 @@ -5,24 +5,18 @@ =========== -Git support in Kallithea 1.3 was enabled by default. You need to have a git -client installed on the machine to make git fully work. +Kallithea Git support is enabled by default. You just need a git +command line client installed on the server to make Git work fully. -Although There is one limitation on git usage. - -- large pushes requires a http server with chunked encoding support. +Web server with chunked encoding +-------------------------------- -if you plan to use git you need to run Kallithea with some -http server that supports chunked encoding which git http protocol uses, -i recommend using waitress_ or gunicorn_ (linux only) for `paste` wsgi app -replacement. Starting from version 1.4 waitress_ is the default wsgi server -used in Kallithea. +Large Git pushes do however require a http server with support for chunked encoding for POST. -To use, simply change change the following in the .ini file:: +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. - use = egg:Paste#http - -to:: +The default paste server is controlled in the .ini file:: use = egg:waitress#main @@ -31,18 +25,18 @@ use = egg:gunicorn#main -And comment out bellow options:: +Also make sure to comment out the following options:: threadpool_workers = threadpool_max_requests = use_threadpool = -You can simply run `paster serve` as usual. - +Disabling Git +------------- You can always disable git/hg support by editing a -file **kallithea/__init__.py** and commenting out backends +file **kallithea/__init__.py** and commenting out the backend. .. code-block:: python