[reference] Initial commit of just the barebones configuration options for the framework bundle

weaverryan · weaverryan · commit 0fbd4bf39c5c · 2011-05-24T21:28:21.000-05:00
diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst
@@ -0,0 +1,112 @@
+.. index::
+   single: Configuration Reference; Framework
+
+FrameworkBundle Configuration
+=============================
+
+The ``FrameworkBundle`` contains most of the "base" framework functionality
+and can be configured under the ``framework`` key in your application configuration.
+This includes settings related to sessions, translation, forms, validation,
+routing and more.
+
+Full Default Configuration
+--------------------------
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        framework:
+            # general configuration
+            cache_warmer:   %kernel.debug%
+            charset:        ~
+            secret:         ~
+            exception_controller: Symfony\\Bundle\\FrameworkBundle\\Controller\\ExceptionController::showAction
+            ide:            ~
+            test:           ~
+            
+            # form configuration
+            form:
+                enabled:    true
+            csrf_protection:
+                enabled:    true
+                field_name: _token
+            
+            # esi configuration
+            esi:
+                enabled:    true
+            
+            # profiler configuration
+            profiler:
+                only_exceptions:      false
+                only_master_requests: false
+                dsn:        sqlite:%kernel.cache_dir%/profiler.db
+                username:   ''
+                password:   ''
+                lifetime:   86400
+                matcher:
+                    ip:       ~
+                    path:     ~
+                    service:  ~
+
+            # router configuration
+            router:
+                cache_warmer:   false
+                resource:       ~
+                type:           ~
+                http_port:      80
+                https_port:     443
+
+            # session configuration
+            session:
+                auto_start:     ~
+                default_locale: en
+                storage_id:     session.storage.native
+                name:           ~
+                lifetime:       ~
+                path:           ~
+                domain:         ~
+                secure:         ~
+                httponly:       ~
+
+            # templating configuration
+            templating:
+                assets_version: ~
+                assets_base_urls: []
+                cache:          ~
+                cache_warmer:   false
+                engines:        []
+                loaders:        []
+                packages:       []
+
+            # translator configuration
+            translator:
+                enabled:        true
+                fallback:       en
+            
+            validation:
+                enabled:        true
+                cache:          ~
+                enable_annotations: false
+
+            # annotations configuration
+            annotations:
+                cache:          file
+                file_cache:
+                    dir:   %kernel.cache_dir%/annotations
+                    debug: %kernel.debug%
+
+General Configuration
+---------------------
+
+* ``cache_warmer`` (type: string)
+
+* ``charset`` (type: string)
+
+* ``secret`` (type: string, *required*)
+
+* ``exception_controller`` (type: string)
+
+* ``ide`` (type: string)
+
+* ``test`` (type: Boolean)
