diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -131,7 +131,8 @@ Listed bellow are various support resour .. note:: - Please try to read the documentation before posting any issues + Please try to read the documentation before posting any issues, especially + the **troubleshooting section** - Join the `Google group `_ and ask any questions. diff --git a/docs/conf.py b/docs/conf.py --- a/docs/conf.py +++ b/docs/conf.py @@ -54,8 +54,8 @@ copyright = u'%s, Marcin Kuzminski' % (d # The short X.Y version. root = os.path.dirname(os.path.dirname(__file__)) sys.path.append(root) -from rhodecode import get_version, __version__ -version = get_version() +from rhodecode import __version__ +version = __version__ # The full version, including alpha/beta/rc tags. release = __version__ diff --git a/docs/index.rst b/docs/index.rst --- a/docs/index.rst +++ b/docs/index.rst @@ -25,6 +25,7 @@ Users Guide usage/statistics usage/backup usage/debugging + usage/troubleshooting **Develop** diff --git a/docs/setup.rst b/docs/setup.rst --- a/docs/setup.rst +++ b/docs/setup.rst @@ -687,43 +687,9 @@ environment. Other configuration files ------------------------- -Some example init.d scripts can be found here, for debian and gentoo: - -https://rhodecode.org/rhodecode/files/tip/init.d - - -Troubleshooting ---------------- - -:Q: **Missing static files?** -:A: Make sure either to set the `static_files = true` in the .ini file or - double check the root path for your http setup. It should point to - for example: - /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public - -| - -:Q: **Can't install celery/rabbitmq** -:A: Don't worry RhodeCode works without them too. No extra setup is required. +Some example init.d scripts can be found in init.d directory:: -| - -:Q: **Long lasting push timeouts?** -:A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts - are caused by https server and not RhodeCode. - -| - -:Q: **Large pushes timeouts?** -:A: Make sure you set a proper max_body_size for the http server. - -| - -:Q: **Apache doesn't pass basicAuth on pull/push?** -:A: Make sure you added `WSGIPassAuthorization true`. - -For further questions search the `Issues tracker`_, or post a message in the -`google group rhodecode`_ + https://secure.rhodecode.org/rhodecode/files/beta/init.d .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/ @@ -734,4 +700,4 @@ For further questions search the `Issues .. _mercurial-server: http://www.lshift.net/mercurial-server.html .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues -.. _google group rhodecode: http://groups.google.com/group/rhodecode +.. _google group rhodecode: http://groups.google.com/group/rhodecode \ No newline at end of file diff --git a/docs/usage/troubleshooting.rst b/docs/usage/troubleshooting.rst new file mode 100644 --- /dev/null +++ b/docs/usage/troubleshooting.rst @@ -0,0 +1,70 @@ +.. _troubleshooting: + + +=============== +Troubleshooting +=============== + +:Q: **Missing static files?** +:A: Make sure either to set the `static_files = true` in the .ini file or + double check the root path for your http setup. It should point to + for example: + /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public + +| + +:Q: **Can't install celery/rabbitmq?** +:A: Don't worry RhodeCode works without them too. No extra setup is required. + Try out great celery docs for further help. + +| + +:Q: **Long lasting push timeouts?** +:A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts + are caused by https server and not RhodeCode. + +| + +:Q: **Large pushes timeouts?** +:A: Make sure you set a proper max_body_size for the http server. Very often + Apache, Nginx or other http servers kill the connection due to to large + body. + +| + +:Q: **Apache doesn't pass basicAuth on pull/push?** +:A: Make sure you added `WSGIPassAuthorization true`. + +| + +:Q: **Git fails on push/pull?** +:A: Make sure you're using an wsgi http server that can handle chunked encoding + such as `waitress` or `gunicorn` + +| + +:Q: **How i use hooks in RhodeCode?** +:A: It's easy if they are python hooks just use advanced link in hooks section + in Admin panel, that works only for Mercurial. If you want to use githooks, + just install proper one in repository eg. create file in + `/gitrepo/hooks/pre-receive`. You can also use RhodeCode-extensions to + connect to callback hooks, for both Git and Mercurial. + +| + +:Q: **RhodeCode is slow for me, how can i make it faster?** +:A: See the :ref:`performance` section + +For further questions search the `Issues tracker`_, or post a message in the +`google group rhodecode`_ + +.. _virtualenv: http://pypi.python.org/pypi/virtualenv +.. _python: http://www.python.org/ +.. _mercurial: http://mercurial.selenic.com/ +.. _celery: http://celeryproject.org/ +.. _rabbitmq: http://www.rabbitmq.com/ +.. _python-ldap: http://www.python-ldap.org/ +.. _mercurial-server: http://www.lshift.net/mercurial-server.html +.. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories +.. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues +.. _google group rhodecode: http://groups.google.com/group/rhodecode \ No newline at end of file