Mercurial > kallithea
annotate 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 |
rev | line source |
---|---|
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
1 .. _git_support: |
811 | 2 |
2095 | 3 =========== |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
4 GIT support |
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
5 =========== |
811 | 6 |
7 | |
4902 | 8 Kallithea Git support is enabled by default. You just need a git |
9 command line client installed on the server to make Git work fully. | |
2325
18d34a56a736
fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
10 |
4902 | 11 Web server with chunked encoding |
12 -------------------------------- | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
13 |
4902 | 14 Large Git pushes do however require a http server with support for chunked encoding for POST. |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
15 |
4902 | 16 The Python web servers waitress_ and gunicorn_ (linux only) can be used. |
17 By default, Kallithea uses waitress_ for `paster serve` instead of the built-in `paste` WSGI server. | |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
18 |
4902 | 19 The default paste server is controlled in the .ini file:: |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
20 |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
21 use = egg:waitress#main |
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
22 |
2325
18d34a56a736
fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
23 or:: |
18d34a56a736
fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
24 |
18d34a56a736
fix for issue #417, git execution was broken on windows for certain commands.
Marcin Kuzminski <marcin@python-works.com>
parents:
2095
diff
changeset
|
25 use = egg:gunicorn#main |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
26 |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
27 |
4902 | 28 Also make sure to comment out the following options:: |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
29 |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
30 threadpool_workers = |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
31 threadpool_max_requests = |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
32 use_threadpool = |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
33 |
2024
370e995e46c2
fixes in doc about waitress wsgi
Marcin Kuzminski <marcin@python-works.com>
parents:
2023
diff
changeset
|
34 |
4902 | 35 Disabling Git |
36 ------------- | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
37 |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
38 You can always disable git/hg support by editing a |
4902 | 39 file **kallithea/__init__.py** and commenting out the backend. |
811 | 40 |
41 .. code-block:: python | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
42 |
811 | 43 BACKENDS = { |
44 'hg': 'Mercurial repository', | |
45 #'git': 'Git repository', | |
46 } | |
47 | |
2023
c45fb78969a3
docs updates on git support
Marcin Kuzminski <marcin@python-works.com>
parents:
1123
diff
changeset
|
48 .. _waitress: http://pypi.python.org/pypi/waitress |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2992
diff
changeset
|
49 .. _gunicorn: http://pypi.python.org/pypi/gunicorn |