comparison 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
comparison
equal deleted inserted replaced
4901:409eaadc0054 4902:03bbd33bc084
3 =========== 3 ===========
4 GIT support 4 GIT support
5 =========== 5 ===========
6 6
7 7
8 Git support in Kallithea 1.3 was enabled by default. You need to have a git 8 Kallithea Git support is enabled by default. You just need a git
9 client installed on the machine to make git fully work. 9 command line client installed on the server to make Git work fully.
10 10
11 Although There is one limitation on git usage. 11 Web server with chunked encoding
12 --------------------------------
12 13
13 - large pushes requires a http server with chunked encoding support. 14 Large Git pushes do however require a http server with support for chunked encoding for POST.
14 15
15 if you plan to use git you need to run Kallithea with some 16 The Python web servers waitress_ and gunicorn_ (linux only) can be used.
16 http server that supports chunked encoding which git http protocol uses, 17 By default, Kallithea uses waitress_ for `paster serve` instead of the built-in `paste` WSGI server.
17 i recommend using waitress_ or gunicorn_ (linux only) for `paste` wsgi app
18 replacement. Starting from version 1.4 waitress_ is the default wsgi server
19 used in Kallithea.
20 18
21 To use, simply change change the following in the .ini file:: 19 The default paste server is controlled in the .ini file::
22
23 use = egg:Paste#http
24
25 to::
26 20
27 use = egg:waitress#main 21 use = egg:waitress#main
28 22
29 or:: 23 or::
30 24
31 use = egg:gunicorn#main 25 use = egg:gunicorn#main
32 26
33 27
34 And comment out bellow options:: 28 Also make sure to comment out the following options::
35 29
36 threadpool_workers = 30 threadpool_workers =
37 threadpool_max_requests = 31 threadpool_max_requests =
38 use_threadpool = 32 use_threadpool =
39 33
40 34
41 You can simply run `paster serve` as usual. 35 Disabling Git
42 36 -------------
43 37
44 You can always disable git/hg support by editing a 38 You can always disable git/hg support by editing a
45 file **kallithea/__init__.py** and commenting out backends 39 file **kallithea/__init__.py** and commenting out the backend.
46 40
47 .. code-block:: python 41 .. code-block:: python
48 42
49 BACKENDS = { 43 BACKENDS = {
50 'hg': 'Mercurial repository', 44 'hg': 'Mercurial repository',