User Tools

Site Tools


plugins:configuration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
plugins:configuration [2016/03/21 11:19]
nuxwin
plugins:configuration [2017/10/23 11:08]
nuxwin [Creating Plugin Local Configuration File]
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====
/var/www/virtual/i-mscp.net/wiki/htdocs/data/pages/plugins/configuration.txt · Last modified: 2018/03/21 11:10 by nuxwin