plugins:configuration
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
plugins:configuration [2016/03/21 11:19] nuxwin |
plugins:configuration [2018/03/21 11:10] (current) nuxwin |
||
|---|---|---|---|
| Line 24: | Line 24: | ||
| Most plugins provide a standardized config.php configuration file (see above) which is located at root of their directory. This file is not persistent, meaning that on each plugin update, you'll have to backup and restore it once the new plugin version will be uploaded. | Most plugins provide a standardized config.php configuration file (see above) which is located at root of their directory. This file is not persistent, meaning that on each plugin update, you'll have to backup and restore it once the new plugin version will be uploaded. | ||
| - | Because that behavior is not really convenient, the plugin API provides a way to solve that issue in a more elegant way by creating local configuration files. Local plugin configuration files are automatically merged with the primary configuration files. Those files are persistent and are never deleted automatically, even when i-MSCP get updated. | + | Because that behavior is not really convenient, the plugin API provides a way to solve that issue in a more elegant way by creating local configuration files. Local plugin configuration files are automatically merged with the primary configuration files. Those files are persistent and are never deleted automatically, even when i-MSCP is being updated. |
| ====How It Works==== | ====How It Works==== | ||
| Line 36: | Line 36: | ||
| All plugin local configuration files must be stored in the **imscp/gui/data/persistent/plugins** directory. | All plugin local configuration files must be stored in the **imscp/gui/data/persistent/plugins** directory. | ||
| - | Local configuration files *MUST* be named with plugin name followed by the php file extension. For instance, if the plugin for which you want create a local configuration file is named **JailKit**, the local configuration file *MUST* be named **JailKit.php** | + | Local configuration files *MUST* be named with plugin name followed by the php file extension. For instance, if the plugin for which you want create a local configuration file is named **InstanSSH**, the local configuration file *MUST* be named **InstanSSH.php** |
| ====Plugin Local Configuration File Sample==== | ====Plugin Local Configuration File Sample==== | ||
| Line 111: | Line 111: | ||
| <?php | <?php | ||
| return array( | return array( | ||
| - | '__OVERRIDE__' => array( | ||
| - | // Override default jail roor directory | ||
| - | 'root_jail_dir' => '/var/www/imscp-jails', | ||
| - | | ||
| - | // Append the git section to the jail_app_sections parameter | ||
| - | 'jail_app_sections' => array( | ||
| - | 'git' | ||
| - | ) | ||
| - | ), | ||
| '__REMOVE__' => array( | '__REMOVE__' => array( | ||
| // Remove mysql-client section from the jail_app_section parameter | // Remove mysql-client section from the jail_app_section parameter | ||
| Line 133: | Line 124: | ||
| ); | ); | ||
| - | Here, the special array key **%%__OVERRIDE__%%** defines an array which contain elements to add/override, and the second special array key **%%__REMOVE__%%**, an array which contain elements to remove. | + | Here, the special array key **%%__REMOVE__%%** contains elements to remove. |
| --- //[[[email protected]|Nuxwin]] 2014/02/24 06:00// | --- //[[[email protected]|Nuxwin]] 2014/02/24 06:00// | ||
/var/www/virtual/i-mscp.net/wiki/htdocs/data/attic/plugins/configuration.1458559156.txt.gz · Last modified: 2016/03/21 11:19 by nuxwin
