Added simple docs for optimizing RhodeCode performance

docs/usage/performance.rst

@@ -0,0 +1,38 b''
+.. _performance:
+
+================================
+Optimizing RhodeCode Performance
+================================
+
+
+Follow these few steps to improve performance of RhodeCode system.
+
+
+1. Increase cache::
+
+    in the .ini file    
+    beaker.cache.sql_cache_long.expire=3600 <-- set this to higher number
+
+    This option affects the cache expiration time for main page. Having
+    few hundreds of repositories on main page can sometimes make the system
+    to behave slow when cache expires for all of them. Increasing `expire`
+    option to day (86400) or a week (604800) will improve general response
+    times for the main page
+
+2. Switch from sqlite to postgres or mysql
+    
+    sqlite is a good option when having small load on the system. But due to
+    locking issues with sqlite, it's not recommended to use it for larger
+    setup. Switching to mysql or postgres will result in a immediate
+    performance increase.
+    
+3. Scale RhodeCode horizontally
+    
+
+    - running two or more instances on the same server can speed up things a lot
+    - load balance using round robin or ip hash
+    - you need to handle consistent user session storage by switching to 
+      db sessions, client side sessions or sharing session data folder across 
+      instances. See http://beaker.readthedocs.org/ docs for details.
+    - remember that each instance needs it's own .ini file and unique
+      `instance_id` set in them
  No newline at end of file

docs/index.rst

@@ -1,60 +1,61 b''
 .. _index:
 
 .. include:: ./../README.rst
 
 Users Guide
 -----------
 
 **Installation:**
 
 .. toctree::
    :maxdepth: 1
 
    installation
    setup
    upgrade
    
 **Usage**
 
 .. toctree::
    :maxdepth: 1
 
    usage/general
    usage/git_support
+   usage/performance
    usage/statistics
    usage/backup
    usage/debugging
 
 **Develop**
 
 .. toctree::
    :maxdepth: 1
    
    contributing
    changelog
 
 **API**
 
 .. toctree::
    :maxdepth: 1
 
    api/api
    api/models
    
 
 Other topics
 ------------
 
 * :ref:`genindex`
 * :ref:`search`
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
 .. _bitbucket: http://bitbucket.org/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _vcs: http://pypi.python.org/pypi/vcs
  No newline at end of file