Mercurial > kallithea

annotate docs/usage/troubleshooting.rst @ 8884:883a0c6c425f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: document how proxy servers must be configured
author Mads Kiilerich <mads@kiilerich.com>
date Sun, 09 May 2021 22:17:21 +0200
parents 20e850093f1c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 Troubleshooting
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 ===============
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 :Q: **Missing static files?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
8 :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
9 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
10 for example:
8209
01aca0a4f876 py3: officially support Python 3
Mads Kiilerich <mads@kiilerich.com>
parents: 8193
diff changeset
11 ``/home/my-virtual-python/lib/python3.7/site-packages/kallithea/public``
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
12
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
13 |
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
14
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15 :Q: **Can't install celery/rabbitmq?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
16 :A: Don't worry. Kallithea works without them, too. No extra setup is required.
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
17 Try out the great Celery docs for further help.
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
18
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
19 |
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
20
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
21 :Q: **Long lasting push timeouts?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
22 :A: Make sure you set a longer timeout in your proxy/fcgi settings. Timeouts
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
23 are caused by the http server and not Kallithea.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
24
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 2601
diff changeset
25 |
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
26
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
27 :Q: **Large pushes timeouts?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
28 :A: Make sure you set a proper ``max_body_size`` for the http server. Very often
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
29 Apache, Nginx, or other http servers kill the connection due to to large
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30 body.
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
31
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 :Q: **Apache doesn't pass basicAuth on pull/push?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
35 :A: Make sure you added ``WSGIPassAuthorization true``.
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
36
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 :Q: **Git fails on push/pull?**
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
40 :A: Make sure you're using a WSGI http server that can handle chunked encoding
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
41 such as ``waitress`` or ``gunicorn``.
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
42
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
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
45 :Q: **How can I use hooks in Kallithea?**
8845
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
46 :A: If using Mercurial, use *Admin > Settings > Hooks* to install
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
47 global hooks. Inside the hooks, you can use the current working directory to
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
48 control different behaviour for different repositories.
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
49
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
50 If using Git, install the hooks manually in each repository, for example by
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
51 creating a file ``gitrepo/hooks/pre-receive``.
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
52 Note that Kallithea uses the ``post-receive`` hook internally.
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
53 Kallithea will not work properly if another post-receive hook is installed instead.
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
54 You might also accidentally overwrite your own post-receive hook with the Kallithea hook.
8846
20e850093f1c hooks: on Git, invoke hooks/post-receive-custom from hooks/post-receive
Mads Kiilerich <mads@kiilerich.com>
parents: 8845
diff changeset
55 Instead, put your post-receive hook in ``post-receive-custom``, and the Kallithea hook will invoke it.
8845
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
56
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
57 You can also use Kallithea-extensions to connect to callback hooks,
d8e65780dbe9 hooks: clarify in UI and documentation how the hook control essentially is Mercurial only
Mads Kiilerich <mads@kiilerich.com>
parents: 8209
diff changeset
58 for both Git and Mercurial.
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
59
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
60 |
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
61
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
62 :Q: **Kallithea is slow for me, how can I make it faster?**
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
63 :A: See the :ref:`performance` section.
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
64
3240
af2059eead28 troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
65 |
af2059eead28 troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
66
af2059eead28 troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
67 :Q: **UnicodeDecodeError on Apache mod_wsgi**
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4522
diff changeset
68 :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
69
4a99684543f7 fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents: 3240
diff changeset
70 |
4a99684543f7 fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents: 3240
diff changeset
71
4a99684543f7 fixes #753 inform about some problems with antivirus software in RhodeCode
Marcin Kuzminski <marcin@python-works.com>
parents: 3240
diff changeset
72 :Q: **Requests hanging on Windows**
5822
84d2a9aaa1a4 spelling: antivirus
timeless@gmail.com
parents: 5434
diff changeset
73 :A: Please try out with disabled Antivirus software, there are some known problems with Eset Antivirus. Make sure
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
74 you have installed the 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
75
3240
af2059eead28 troubleshooting docs, added modwsgi unicode problems link from django
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
76
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
77 .. _python: http://www.python.org/
6334
cc21a2b86a30 docs: update links to Mercurial's website and wiki
Anton Shestakov <av6@dwimlabs.net>
parents: 5434
diff changeset
78 .. _mercurial: https://www.mercurial-scm.org/
2601
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
79 .. _celery: http://celeryproject.org/
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
80 .. _rabbitmq: http://www.rabbitmq.com/
aa90719e8520 Added troubleshooting section to docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
81 .. _python-ldap: http://www.python-ldap.org/