plugins:demo
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
plugins:demo [2014/02/23 09:34] nuxwin [Modal dialog box on login page] |
plugins:demo [2014/02/23 09:44] (current) nuxwin |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| =====Demo Plugin===== | =====Demo Plugin===== | ||
| - | ======Introduction====== | + | ======REQUIREMENTS====== |
| + | |||
| + | * i-MSCP >= 1.1.0 | ||
| + | |||
| + | ======INTRODUCTION====== | ||
| The demo plugin allow to setup an i-MSCP demo server in few minutes. | The demo plugin allow to setup an i-MSCP demo server in few minutes. | ||
| Line 10: | Line 14: | ||
| - Provide an actions list that must be disabled | - Provide an actions list that must be disabled | ||
| - | =====Plugin configuration===== | + | =====CONFIGURATION===== |
| ====Modal dialog box on login page==== | ====Modal dialog box on login page==== | ||
| Line 33: | Line 37: | ||
| ====Protection against deletion and password modification (Demo users)==== | ====Protection against deletion and password modification (Demo users)==== | ||
| - | If an user account has the protected option set to TRUE (as above), it will be protected against deletion, and password modification. | + | If an user account has the protected option set to TRUE (//as above//), it will be protected against deletion, and password modification. |
| ====Disabled actions==== | ====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 59: | Line 63: | ||
| A configuration file for the demo plugin can be: | A configuration file for the demo plugin can be: | ||
| - | // Configuration file sample for the demo plugin | + | // Configuration file sample for the demo plugin |
| + | |||
| return array( | return array( | ||
| // List of user accounts that will be available via select box on login page. If an user account is protected, it | // List of user accounts that will be available via select box on login page. If an user account is protected, it | ||
| Line 166: | Line 170: | ||
| 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]]. | 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]]. | ||
| - | =====Plugin activation===== | + | =====ACTIVATION===== |
| - | To activate the plugin, you must configure it and update the plugin list via the i-MSCP plugin management interface. Once it's done, you must activate it by clicking on the activate link into the plugin management interface. | + | To activate the plugin, you must in order: |
| + | |||
| + | - configure it by editing the plugins/Demo/config.php configuration file | ||
| + | - go to the plugin management interface | ||
| + | - cick on the **Update Plugins** button | ||
| + | - click on the activate icone. | ||
| **Important** | **Important** | ||
| - | In production environment, this plugin must be protected against deactivation. For this, you must protect it by clicking on the **protect** link in the plugin management interface. | + | In production environment, this plugin must be protected against deactivation. For this, you must protect it by clicking on the **protect** icone in the plugin management interface. |
| - | =====Plugin deactivation===== | + | =====DEACTIVATION===== |
| + | |||
| + | First, if the plugin is protected, you must edit the **gui/data/persistent/protected_plugins.php** file to remove it from the list of protected plugins. After, you will be able to deactivate it by clicking on the **deactivate** icone in the plugin management interface. | ||
| + | |||
| + | =====LICENSE===== | ||
| + | |||
| + | Copyright (C) 2010-2014 by Laurent Declercq [email protected] | ||
| + | |||
| + | This program is free software; you can redistribute it and/or modify it under | ||
| + | the terms of the GNU General Public License as published by the Free Software | ||
| + | Foundation; version 2 of the License | ||
| + | |||
| + | This program is distributed in the hope that it will be useful, but WITHOUT | ||
| + | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| + | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. | ||
| - | First, if the plugin is protected, you must edit the **gui/data/persistent/protected_plugins.php** file to remove it from the list of protected plugins. After, you will be able to deactivate it by clicking on the **deactivate** link into the plugin management interface. | + | =====AUTHORS===== |
| - | Feel free to test it and report any bugs or suggestions for improvement. | + | * Laurent Declercq <l.[email protected]> |
/var/www/virtual/i-mscp.net/wiki/htdocs/data/attic/plugins/demo.1393148043.txt.gz · Last modified: 2014/02/23 09:34 by nuxwin
