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