Vo Minh Thu (OpenERP) has proposed merging lp:~openerp-dev/openobject-server/trunk-doc-dev_contrib-vmt into lp:~openerp-dev/openobject-server/trunk-doc-dev_contrib-tde.
Requested reviews: OpenERP R&D Team (openerp-dev) For more details, see: https://code.launchpad.net/~openerp-dev/openobject-server/trunk-doc-dev_contrib-vmt/+merge/102699 -- https://code.launchpad.net/~openerp-dev/openobject-server/trunk-doc-dev_contrib-vmt/+merge/102699 Your team OpenERP R&D Team is requested to review the proposed merge of lp:~openerp-dev/openobject-server/trunk-doc-dev_contrib-vmt into lp:~openerp-dev/openobject-server/trunk-doc-dev_contrib-tde.
=== added file 'doc/90_using_gunicorn.rst' --- doc/90_using_gunicorn.rst 1970-01-01 00:00:00 +0000 +++ doc/90_using_gunicorn.rst 2012-04-19 13:29:18 +0000 @@ -0,0 +1,101 @@ +.. _using-gunicorn: + +Deploying with Gunicorn +======================= + +Starting with OpenERP 6.1, the server and web addons are WSGI_ compliant. In +particular, support for the Gunicorn_ HTTP server is available. For some +background information and motivation, please read http://www.openerp.com/node/1106. +To install Gunicorn, please refer to Gunicorn's website. + +.. _Gunicorn: http://gunicorn.org/ +.. _WSGI: http://en.wikipedia.org/wiki/Web_Server_Gateway_Interface + +Summary +------- + +Configuring and starting an OpenERP server with Gunicorn is straightfoward. The +different sections below give more details but the following steps are all it +takes:: + +1. Use a configuration file, passing it to ``gunicorn`` using the ``-c`` + option. +2. Within the same configuration file, also configure OpenERP. +3. Run ``gunicorn openerp:wsgi.core.application -c gunicorn.conf.py``. + +Sample configuration file +------------------------- + +A sample ``gunicorn.conf.py`` configuration file for Gunicorn can be found in +the OpenERP server source tree. It is fairly well commented and easily +customizable for your own usage. While reading the remaining of this page, it +is advised you take a look at the sample ``gunicorn.conf.py`` file as it makes +things easier to follow. + +Configuration +------------- + +Gunicorn can be configured by a configuration file and/or command-line +arguments. For a list of available options, you can refer to the official +Gunicorn documentation http://gunicorn.org/configure.html. + +When the OpenERP server is started on its own, by using the ``openerp-server`` +script, it can also be configured by a configuration file or its command-line +arguments. But when it is run via Gunicorn, it is no longer the case. Instead, +as the Gunicorn configuration file is a full-fledged Python file, we can +``import openerp`` in it and configure directly the server. + +The principle can be summarized with this three lines (although they are spread +across the whole sample ``gunicorn.conf.py`` file):: + + import openerp + conf = openerp.tools.config + conf['addons_path'] = '/home/openerp/addons/trunk,/home/openerp/web/trunk/addons' + +The above three lines first import the ``openerp`` library (i.e. the one +containing the OpenERP server implementation). The second one is really to +shorten repeated usage of the same variable. The third one sets a parameter, in +this case the equivalent of the ``--addons-path`` command-line option. + +Finally, Gunicorn offers a few hooks so we can call our own code at some points +in its execution. The most important one is the ``on_starting`` hook. It lets +us properly initialize the ``openerp`` library before Gunicorn starts handling +requests. ``pre_request`` and ``post_request`` are called before and after +requests are handled. We provide functions in ``openerp.wsgi.core`` that can be +used to define those hooks: a typical Gunicorn configuration for OpenERP will +thus contains:: + + on_starting = openerp.wsgi.core.on_starting + pre_request = openerp.wsgi.core.pre_request + post_request = openerp.wsgi.core.post_request + +Running +------- + +Once a proper configuration file is available, running the OpenERP server with +Gunicorn can be done with the following command:: + + > gunicorn openerp:wsgi.core.application -c gunicorn.conf.py + +``openerp`` must be importable by Python. The simplest way is to run the above +command from the server source directory (i.e. the directory containing the +``openerp`` module). Alternatively, the module can be installed on your machine +as a regular Python library or added to your ``PYTHONPATH``. + +Running behind a reverse proxy +------------------------------ + +If you intend to run Gunicorn behind a reverse proxy (nginx_ is recommended), +an alternative entry point is available in ``openerp.wsgi.proxied``. That entry +point uses werkzeug's ProxyFix_ class to set a few headers. You first have to +explicitely import that sub-module if you want to use it. So add this line in +the configuration file:: + + import openerp.wsgi.proxied + +and then adapt the command-line:: + + > gunicorn openerp:wsgi.proxied.application -c gunicorn.conf.py + +.. _nginx: http://nginx.org/en/ +.. _ProxyFix: http://werkzeug.pocoo.org/docs/contrib/fixers/#werkzeug.contrib.fixers.ProxyFix === modified file 'doc/index.rst.inc' --- doc/index.rst.inc 2012-04-17 14:17:46 +0000 +++ doc/index.rst.inc 2012-04-19 13:29:18 +0000 @@ -9,9 +9,10 @@ 02_architecture 03_module_dev 04_user_roles + 90_using_gunicorn 99_test_framework -OPenERP Server API +OpenERP Server API '''''''''''''''''' .. toctree::
_______________________________________________ Mailing list: https://launchpad.net/~openerp-dev-gtk Post to : [email protected] Unsubscribe : https://launchpad.net/~openerp-dev-gtk More help : https://help.launchpad.net/ListHelp
