Changes between Initial Version and Version 1 of PublisherConfiguration


Ignore:
Timestamp:
09/23/2008 01:25:36 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PublisherConfiguration

    v1 v1  
     1{{{ 
     2#!rst 
     3The publisher configuration file 
     4================================ 
     5 
     6 
     7Using the configuration file 
     8---------------------------- 
     9 
     10To configure how an application is published, use the ``-c`` option of the 
     11``serve`` administrative command: 
     12 
     13  .. code-block:: sh 
     14 
     15    <NAGARE_HOME>/bin/nagare-admin serve -c /path/to/the/publisher/config.cfg <application> 
     16 
     17Several examples of publisher configurations are located into ``conf/publishers`` 
     18under the framework installation directory. 
     19 
     20Structure 
     21--------- 
     22 
     23For the boolean parameters, a value of ``true``, ``yes``, ``on`` or ``1`` means True 
     24and a value of ``false``, ``no``, ``off`` or ``0`` mean False. 
     25 
     26Comments, starting with the ``#`` character can be added to a configuration file. 
     27 
     28[publisher] section 
     29~~~~~~~~~~~~~~~~~~~ 
     30 
     31This section defines the publisher to use. 
     32 
     33=================== ========= ================== ================================================ 
     34Name                Mandatory Default value      Description 
     35=================== ========= ================== ================================================ 
     36type                No        standalone         Choice of the publisher to use. 
     37 
     38                                                 The current choices are: 
     39 
     40                                                   - ``standalone``: Python threaded HTTP server 
     41                                                     (convenient in development mode) 
     42                                                   - ``fastcgi``: multi-processes fastcgi server. 
     43                                                     A external HTTP is required (recommended in production) 
     44                                                   - ``fapws2``: fast events drivent HTTP server (experimental) 
     45                                                   - ``eventlet``: fast events drivent HTTP server (experimental) 
     46host                No        127.0.0.1          By default, the publisher only accepts requests 
     47                                                 on the local interface. If you want to accept 
     48                                                 external requests, set this parameter to the 
     49                                                 internet address of your external interface or 
     50                                                 to '0.0.0.0' to listen to on all the interfaces 
     51                                                 of your system. 
     52                                                 The optional ``--host`` on the command line 
     53                                                 takes precedence over this parameter.  
     54port                No        *publisher         Port where to listen to the requests. If no 
     55                              dependante*        value is explicitly given, the ``standalone``, 
     56                                                 ``fapws2`` and ``eventlet`` publishers listen on 
     57                                                 port ``8080``. And the ``fastcgi`` publisher 
     58                                                 listen on ``9000``. 
     59                                                 The optional ``--port / -p`` on the command line 
     60                                                 takes precedence over this parameter. 
     61=================== ========= ================== ================================================ 
     62 
     63All other parameters, if present, are passed as keywords to the SQLALchemy 
     64``create_engine()`` call (see http://www.sqlalchemy.org/docs/04/dbengine.html#dbengine_options) 
     65 
     66.. note:: 
     67 
     68   New publishers can be added to the framework, and then selected with the ``type`` 
     69   parameter, by registering them under the ``[nagare.publishers]`` entry point 
     70   (see :wiki:`EntryPoints`). 
     71 
     72[sessions] section 
     73~~~~~~~~~~~~~~~~~~ 
     74 
     75This section defined the sessions manager to use. 
     76 
     77=================== ========= ================== ================================================ 
     78Name                Mandatory Default value      Description 
     79=================== ========= ================== ================================================ 
     80type                No        standalone         Choice of the sessions manager to use. 
     81 
     82                                                 The current choices are: 
     83 
     84                                                   - ``standalone``: threads-safe in-memory sessions 
     85                                                     manager. Can be used with the ``standalon``, 
     86                                                     ``fapws2`` or ``eventlet`` publisher.  
     87                                                   - ``memcache``: the sessions are stored and 
     88                                                     shared into an external memcached server. 
     89                                                     Can be use will all the publishers 
     90=================== ========= ================== ================================================ 
     91 
     92If the ``type`` parameter has the value ``standalone``, the following parameters 
     93can be configurated: 
     94 
     95=================== ========= ================== ================================================ 
     96Name                Mandatory Default value      Description 
     97=================== ========= ================== ================================================ 
     98nb                  No        10000              Maximum number of sessions keeped 
     99=================== ========= ================== ================================================ 
     100 
     101If the ``type`` parameter has the value ``memcache``, the following parameters 
     102can be configurated: 
     103 
     104=================== ========= ================== ================================================ 
     105Name                Mandatory Default value      Description 
     106=================== ========= ================== ================================================ 
     107host                No        127.0.0.1          Address of the memcached server 
     108port                No        11211              Port of the memcached server 
     109ttl                 No        0                  How long (in seconds), do the session live ? 
     110                                                 A value of ``0`` means the sessions are managed 
     111                                                 in LRU. 
     112reset               No        on                 If this parameter is true, then all the sessions 
     113                                                 are removed from the memcached server when the 
     114                                                 application (re)starts. 
     115debug               No        off                Display the requests sent to the memcached server 
     116=================== ========= ================== ================================================ 
     117 
     118.. note:: 
     119 
     120   New sessions managers can be added to the framework, and then selected with the 
     121   ``type`` parameter, by registering them under the ``[nagare.sessions]`` entry point 
     122   (see :wiki:`EntryPoints`). 
     123 
     124[reloader] section 
     125~~~~~~~~~~~~~~~~~~ 
     126 
     127This section configures the reloader process which automatically detect source 
     128changes and relaunch the application. 
     129 
     130=================== ========= ================== ================================================ 
     131Name                Mandatory Default value      Description 
     132=================== ========= ================== ================================================ 
     133activated           No        off                If not activated, the framework will not read 
     134                                                 the following parameters. 
     135                                                 In production, don't activate the reloader. 
     136interval            No        1                  Time, in seconds, between the control of 
     137                                                 source changes 
     138=================== ========= ================== ================================================ 
     139 
     140.. wikiname: PublisherConfiguration 
     141}}}