PageRenderTime 102ms CodeModel.GetById 60ms app.highlight 1ms RepoModel.GetById 40ms app.codeStats 0ms

/docs/appconfig.txt

https://bitbucket.org/ianb/silverlining/
Plain Text | 53 lines | 42 code | 11 blank | 0 comment | 0 complexity | 91b7f53cf68deefa721e030e85735320 MD5 | raw file
 1Application Configuration
 2-------------------------
 3
 4You application is configured with a file ``app.ini``.  It's really
 5recommended that you put this file in your source code repository and
 6symlink it into its location at the root of the app directory.
 7
 8``app_name``:
 9    The name of the application, a simple identifier.
10
11``runner``:
12    This points to the file that "runs" the application.  This can be
13    a ``.py`` file that defines an object ``application``, a WSGI
14    application.  It can also be a ``.ini`` file which has an
15    ``[app:main]`` section that can be loaded by Paste Deploy (e.g.,
16    for a Pylons application).
17
18``update_fetch``:
19    This option gives one (or more) URLs that should be fetched
20    every time the application is updated.  It is also fetched *every
21    time* your development server is started (with ``silver
22    serve``).  (Maybe this last bit should be changed.)
23
24    These can setup tables, create directories, etc.  You can check
25    ``environ['silverlining.update']`` to be sure this is an internal
26    update request.  If you want multiple URLs, put each on its own
27    line (in ``.ini`` files you can use indentation on subsequent
28    lines to continue a configuration value).
29
30``default_location``:
31    This is a default for ``silver update APP LOCATION``, so you don't
32    have to enter that location each time you update.
33
34``service.*``:
35    The presence of the setting activates the `service <services.html>`_.
36    It can have a value, which is passed to the service, but no
37    service uses that yet.
38
39``config.required``:
40    If ``true`` then you must provide configuration to deploy this
41    application.
42
43``config.default``:
44    A path to default configuration for the application.
45
46``config.template``:
47    Configuration template files.  See `Deployment Configuration
48    <deploymentconfig.html>`_ for more.
49
50``config.checker``:
51    A ``module:function`` that checks the configuration and raises an
52    exception if there is a problem.  See `Deployment Configuration
53    <deploymentconfig.html>`_ for more.