| 3 | | This is a stub (please write me) |
| | 3 | Kohana adopts the philosophy of *convention* over *configuration*. The goal is to minimize user configuration. Where configuration is required or enabled, sensible defaults are utilised. |
| | 4 | |
| | 5 | System configuration is specified by entries in files located in folder */application/config/*. |
| | 6 | |
| | 7 | Configuration files are ordinary text files with a default *php* file extension. |
| | 8 | |
| | 9 | The primary configuration file is <file>/application/config/config</file> System wide configuration is |
| | 10 | specified here and is required for every new installation. |
| | 11 | |
| | 12 | **Note:** Optional entries are indicated by square brackets. |
| | 13 | |
| | 14 | ## Config entries |
| | 15 | ### Base URL |
| | 16 | Specifies the url which points to the base or root of your application. |
| | 17 | Format: |
| | 18 | <pre>config item domain name /[subdirectory/]</pre> |
| | 19 | <code> |
| | 20 | $config['base_url'] = 'http://'.$_SERVER['SERVER_NAME'].'/kohana/'; |
| | 21 | </code> |
| | 22 | *base_url* is **mandatory** and requires a correct server domain that **must** terminate with a "**/**" |
| | 23 | |
| | 24 | ### Front Controller |
| | 25 | Specifies the name of the system *Front Controller*, usually <file>index</file>, but may be renamed. |
| | 26 | Format: |
| | 27 | <pre>config item [front controller name]</pre> |
| | 28 | <code> |
| | 29 | $config['index_page'] = 'index.php'; |
| | 30 | </code> |
| | 31 | *index_page* is **optional**. If your web server supports dynamic url re-writing. The front controller |
| | 32 | may be dynamically removed fron the uri path. Set this item to blank if you are using re-writes. |
| | 33 | |
| | 34 | ### Url Suffix |
| | 35 | Specifies the suffix which should be dynamically added to the uri path. |
| | 36 | Format: |
| | 37 | <pre>*url_suffix* [suffix]</pre> |
| | 38 | <code> |
| | 39 | $config['url_suffix'] = '.html'; |
| | 40 | </code> |
| | 41 | *url_suffix* is **optional** You may specify any valid extension as a suffix. Set to blank to remove. |
| | 42 | |
| | 43 | ### Permitted URI Characters |
| | 44 | Specifies the characters which the system will allow as part of a uniform resource indicator. |
| | 45 | Format: |
| | 46 | <pre>*permitted_uri_chars* character set</pre> |
| | 47 | <code> |
| | 48 | $config['permitted_uri_chars'] = 'a-z 0-9~%.:_-'; |
| | 49 | </code> |
| | 50 | *permitted_uri_chars* is **mandatory** A minimal character set must be specified or the system cannot function. |
| | 51 | |
| | 52 | **Security Note:** It is recommended that the default character set be used, to secure the system against |
| | 53 | hacking attempts. Additional characters may be configured, but please be aware of the security implication. |
