Skip to content

Commit 5d85f15

Browse files
author
Sebastian Michaelsen
committed
Configuration: document more properties
1 parent 20b7a49 commit 5d85f15

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

in-depth_documentation/configuration.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,21 @@ Line 11 reads the `server_url` from the section `application` and assigns it to
7474
| airbrake.resource | | Resource to call to log exceptions |
7575
| authentication.cookie.name | `SecureSessionCookie` | Name of the PHPFramework secure cookie |
7676
| authentication.cookie.encrypt_key | | Set to a random string if you want to use the PHPFramework secure cookie |
77-
| authentication.http.*&lt;ARRAY&gt;* | | The keys are the the usernames, the values are the sha1 hashes of the passwords to authenticate via HTTP.<br>HTTP authentication must be enables per controller class, by setting `$this->require_http_authentication = TRUE` in it's constructor. |
78-
| authentication.sessionclass | `BasePHPSession` | Class for session handling. For all built-in session classes in PHPFramework you can omit the namespace `AppZap\PHPFramework\Authentication`.
77+
| authentication.http.*&lt;ARRAY&gt;* | | The keys are the the usernames, the values are the sha1 hashes of the passwords to authenticate via HTTP.<br>HTTP authentication must be enabled per controller class, by setting `$this->require_http_authentication = TRUE` in it's constructor. |
78+
| authentication.sessionclass | `BasePHPSession` | Class for session handling. For all built-in session classes in PHPFramework you can omit the namespace `AppZap\PHPFramework\Authentication`. |
79+
| cache.enable | false | Enables caching globally |
80+
| cache.folder | `./cache/` | Directory for cache files. Must be writable. |
81+
| cache.full_output | false | Enables full output caching. That means the rendered output for each url will be cached. |
82+
| cache.full_output_expiration | `20 minutes` | Expiration duration for the full output cache |
83+
| cache.twig_folder | `./cache/twig/` | Directory for twig cache files. Must be writable |
84+
| db.charset | | MySQL charset |
85+
| db.mysql.database | | MySQL database name |
86+
| db.mysql.host | | MySQL host |
87+
| db.mysql.password | | MySQL password |
88+
| db.mysql.user | | MySQL user |
7989
| db.migrator.enable | false | If true the DB migrator is invoked on every page call |
8090
| debug_mode | false | Enables PHP error_reporting `E_ALL` and should also be used by your application to decide wether to output debugging information |
8191
| plugins.*&lt;ARRAY&gt;* | | The keys are the PHP namespaces of the plugins that you are using in your installation and the value is `1`if you want to activate it. Example:<br>`plugins.MyVendor\MyPackage\FirstPlugin = 1`<br>`plugins.MyVendor\MyPackage\SecondPlugin = 0`<br>Will result in the first plugin being loaded and the second not. You can get the Plugin namespaces from the README files of the plugin packages you're using (hopefully). |
8292
| powered_by | true | Adds a HTML comment to the output with a hint to PHPFramework |
93+
| template_file_extension | `.twig` / `.html` | By default PHPFramwork uses the `TwigView` to render templates. Then `.twig` will be the default template file extension.<br>If you use your own view class based on `AbstractView` then `.html` will be the default template file extension. |
8394
| version | *version* | Is automatically set to the current 2-digit version of PHPFramework, e.g. `1.3`. |

0 commit comments

Comments
 (0)