Mercurial > kallithea
annotate docs/usage/troubleshooting.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 | a9a1560dad79 |
children | 4e6dfdb3fa01 |
rev | line source |
---|---|
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
1 .. _troubleshooting: |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
2 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
3 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
4 =============== |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
5 Troubleshooting |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
6 =============== |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
7 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
8 :Q: **Missing static files?** |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
9 :A: Make sure either to set the `static_files = true` in the .ini file or |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
10 double check the root path for your http setup. It should point to |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
11 for example: |
4522
a9a1560dad79
setup: clarify that we only support 2.6 and 2.7
Mads Kiilerich <madski@unity3d.com>
parents:
4192
diff
changeset
|
12 /home/my-virtual-python/lib/python2.7/site-packages/kallithea/public |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
13 |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
14 | |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
15 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
16 :Q: **Can't install celery/rabbitmq?** |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
17 :A: Don't worry Kallithea works without them too. No extra setup is required. |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
18 Try out great celery docs for further help. |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
19 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
20 | |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
21 |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
22 :Q: **Long lasting push timeouts?** |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
23 :A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
24 are caused by https server and not Kallithea. |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
25 |
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
26 | |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
27 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
28 :Q: **Large pushes timeouts?** |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
29 :A: Make sure you set a proper max_body_size for the http server. Very often |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
30 Apache, Nginx or other http servers kill the connection due to to large |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
31 body. |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
32 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
33 | |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
34 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
35 :Q: **Apache doesn't pass basicAuth on pull/push?** |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
36 :A: Make sure you added `WSGIPassAuthorization true`. |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
37 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
38 | |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
39 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
40 :Q: **Git fails on push/pull?** |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
41 :A: Make sure you're using an wsgi http server that can handle chunked encoding |
4902 | 42 such as `waitress` or `gunicorn`. |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
43 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
44 | |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
45 |
4902 | 46 :Q: **How can I use hooks in Kallithea?** |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
47 :A: It's easy if they are python hooks just use advanced link in hooks section |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
48 in Admin panel, that works only for Mercurial. If you want to use githooks, |
3224
8b8edfc25856
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
2601
diff
changeset
|
49 just install proper one in repository eg. create file in |
4192
e73a69cb98dc
Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents:
4186
diff
changeset
|
50 `/gitrepo/hooks/pre-receive`. You can also use Kallithea-extensions to |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
51 connect to callback hooks, for both Git and Mercurial. |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
52 |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
53 | |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
54 |
4902 | 55 :Q: **Kallithea is slow for me, how can I make it faster?** |
56 :A: See the :ref:`performance` section. | |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
57 |
3240
af2059eead28
troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents:
3224
diff
changeset
|
58 | |
af2059eead28
troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents:
3224
diff
changeset
|
59 |
af2059eead28
troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents:
3224
diff
changeset
|
60 :Q: **UnicodeDecodeError on Apache mod_wsgi** |
4902 | 61 :A: Please read: https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/#if-you-get-a-unicodeencodeerror. |
3337
4a99684543f7
fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents:
3240
diff
changeset
|
62 |
4a99684543f7
fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents:
3240
diff
changeset
|
63 | |
4a99684543f7
fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents:
3240
diff
changeset
|
64 |
4a99684543f7
fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents:
3240
diff
changeset
|
65 :Q: **Requests hanging on Windows** |
3338
cfc0fef66ddd
whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents:
3337
diff
changeset
|
66 :A: Please try out with disabled Antivirus software, there are some known problems with Eset Anitivirus. Make sure |
4902 | 67 you have installed latest windows patches (especially KB2789397). |
3337
4a99684543f7
fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents:
3240
diff
changeset
|
68 |
3240
af2059eead28
troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents:
3224
diff
changeset
|
69 |
2601
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
70 .. _virtualenv: http://pypi.python.org/pypi/virtualenv |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
71 .. _python: http://www.python.org/ |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
72 .. _mercurial: http://mercurial.selenic.com/ |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
73 .. _celery: http://celeryproject.org/ |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
74 .. _rabbitmq: http://www.rabbitmq.com/ |
aa90719e8520
Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff
changeset
|
75 .. _python-ldap: http://www.python-ldap.org/ |