plugins:demo
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
plugins:demo [2012/02/04 15:51] nuxwin Created documentation for i-MSCP demo plugin |
plugins:demo [2012/02/17 16:23] nuxwin [II. Plugin activation] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ====== Version Info ====== | ====== Version Info ====== | ||
| - | ^Plugin Version | 0.0.5| | + | ^Plugin Version|0.0.7| |
| - | ^i-MSCP compatibility version | >= 1.0.2.0| | + | ^Author|Laurent Declercq <[email protected]>| |
| - | ^Last Update |03.02.2012| | + | ^License|GPLv2| |
| + | ^i-MSCP compatibility version|>= 1.0.2.0 (No released version)| | ||
| + | ^Last Update|2012-02-16| | ||
| ======Introduction====== | ======Introduction====== | ||
| Line 19: | Line 21: | ||
| ====A. Modal dialog box on login page==== | ====A. Modal dialog box on login page==== | ||
| - | The dialog box is only displayed if you provide a set of configuration that describes user accounts. The plugin configuration file format is a simple PHP associative array (//See the sample below//). | + | The dialog box is only displayed if you provide a set of configuration parameters that describe user accounts. The plugin configuration file contains a simple PHP associative array (//See the sample below//). |
| - | To describe an user account, you must add a section like below in the configuration file: | + | To describe an user account, you must add a new section like below in the configuration file: |
| <code php> | <code php> | ||
| ... | ... | ||
| Line 43: | Line 45: | ||
| ====C. Disabled actions==== | ====C. Disabled actions==== | ||
| - | The plugin allows to disable some actions such as '**addFtp**', '**EditFtp**', '**DeleteFtp**'. The action names are same as event names dispatched in i-MSCP code. Only the **onBefore*** actions are supported (since the others are not really relevant in the demo plugin context). You can see all integrated events by reading the [[https://github.com/i-MSCP/imscp/blob/master/gui/library/iMSCP/Events.php|iMSCP_Events]] class. | + | The plugin allows to disable some actions such as '**addFtp**', '**EditFtp**', '**DeleteFtp**'. The action names are same as event names dispatched in i-MSCP code. Only the **onBefore*** actions are supported since the others are not really relevant in the demo plugin context. You can see all integrated events by reading the [[https://github.com/i-MSCP/imscp/blob/master/gui/library/iMSCP/Events.php|iMSCP_Events]] class. |
| To disable one or more actions, you must add a new section like below in the plugin configuration file: | To disable one or more actions, you must add a new section like below in the plugin configuration file: | ||
| Line 62: | Line 64: | ||
| </code> | </code> | ||
| - | To resume, a configuration file for the demo plugin can be: | + | ====D. Configuration file sample==== |
| + | |||
| + | A configuration file for the demo plugin can be: | ||
| <code php> | <code php> | ||
| Line 102: | Line 106: | ||
| </code> | </code> | ||
| - | This file live in the [[https://github.com/i-MSCP/imscp/tree/master/gui/plugins/Demo|gui/plugins/Demo]] directory and is named [[https://github.com/i-MSCP/imscp/blob/master/gui/plugins/Demo/demo_config.php|demo_config.php]]. | + | This file live in the [[https://github.com/i-MSCP/imscp/tree/master/gui/plugins/Demo|gui/plugins/Demo]] directory and is named [[https://github.com/i-MSCP/imscp/blob/master/gui/plugins/Demo/config.php|config.php]]. |
| =====II. Plugin activation===== | =====II. Plugin activation===== | ||
| - | To activate the plugin, you must just configure it and edit the **/etc/imscp.conf** and set the '**DEMO_SERVER**' variable to **1**. | + | To activate the plugin, you must configure it and update the plugin list via the i-MSCP plugin management interface. After that, you must activate and protect the plugin always via the i-MSCP plugin management interface. |
| Feel free to test it and report any bugs or suggestions for improvement. | Feel free to test it and report any bugs or suggestions for improvement. | ||
/var/www/virtual/i-mscp.net/wiki/htdocs/data/pages/plugins/demo.txt · Last modified: 2014/02/23 09:44 by nuxwin
