[DOC] updated gunicorn doc, a.k.a. why we can't have nice things.

bzr revid: vmt@openerp.com-20130122112658-wu8ffx6h5c4otv1r

diff --git a/doc/09_deployment.rst b/doc/09_deployment.rst
deleted file mode 100644 (file)
index 70f5114..0000000
--- a/doc/09_deployment.rst
+++ /dev/null
@@ -1,101 +0,0 @@
-.. _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

diff --git a/doc/deployment-gunicorn.rst b/doc/deployment-gunicorn.rst
new file mode 100644 (file)
index 0000000..fa4022c
--- /dev/null
+++ b/doc/deployment-gunicorn.rst
@@ -0,0 +1,72 @@
+.. _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:service.wsgi_server.application -c openerp-wsgi.py``.
+
+Sample configuration file
+-------------------------
+
+A sample ``openerp-wsgi.py`` configuration file for WSGI servers 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 ``openerp-wsgi.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://docs.gunicorn.org/en/latest/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 ``openerp-wsgi.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.
+
+Running
+-------
+
+Once a proper configuration file is available, running the OpenERP server with
+Gunicorn can be done with the following command::
+
+  > gunicorn openerp:service.wsgi_server.application -c openerp-wsgi.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``.
+

diff --git a/doc/index.rst b/doc/index.rst
index 37870af..33474e2 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -16,7 +16,7 @@ OpenERP Server
    04_security
    05_test_framework
    06_misc
-   09_deployment
+   deployment-gunicorn
 
 OpenERP Command
 '''''''''''''''