i-MSCP Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
=====i-MSCP Demo Plugin =====

====== Information ======
^Version du plugin|0.0.7|
^Auteur|Laurent Declercq <l.declercq@nuxwin.com>|
^Licence|GPLv2|
^i-MSCP - versions compatibles|>= 1.0.2.1|
^Dernière mise à jour|2012-02-16|

======Introduction======

Le plugin **Demo** permet de créer un serveur de démonstration i-MSCP en quelques minutes.
Il permet:

  - d'afficher une boîte de dialogue sur la page de connexion pour permettre aux utilisateurs de choisir le compte utilisateur avec lequel ils désirent se connecter ;
  - protéger certains comptes utilisateur contre la suppression et la modification de leur mots de passe ;
  - fournir une liste d'actions qui doivent être désactivées.

=====I. Configuration du plugin=====

====A. Boîte de dialogue sur la page de connexion====

La boîte de dialogue est seulement affichée si un jeux de paramètres décrivant des comptes utilisateurs est fournit. Le fichier de configuration du plugin contient un simple tableau associative PHP (voir l'exemple ci-dessous).

Pour décrire un compte utilisateur, une section comme ci-dessous doit être ajoutée dans le fichier de configuration:

<code php>
...
	'user_accounts' => array(
		array(
			'label' => 'Administrator 1',
			'username' => 'admin1',
			'password' => 'admin1',
			'protected' => true
		)
	)
...
</code>

**Note:** Les comptes utilisateur ne sont montrés dans la boîte de dialogue que s'ils existent dans la base de données d'I-MSCP.

====B. Protection des utilisateurs contre la suppression et la modification de leur mots de passe====

Si un compte utilisateur a l'option 'protected' paramétrée à TRUE (comme ci-dessus), il sera protégé contre la suppression et la modification de sont mot de passe.

====C. Actions désactivées====

Le plugin permet de désactiver certaines actions comme **addFtp**', '**EditFtp**', '**DeleteFtp**'. Les noms des actions sont identiques aux noms des événements distribués dans le code d'i-MSCP, à noter que seules les actions **onBefore*** sont pertinentes dans la mesure ou les autres ne sont pas utiles dans le contexte de ce plugin. La liste des actions (événements) déjà intégrées sont disponibles dans la classe [[https://github.com/i-MSCP/imscp/blob/master/gui/library/iMSCP/Events.php|iMSCP_Events]].

Pour désactiver une ou plusieurs actions, une section comme ci-dessous doit être ajoutée dans le fichier de configuration:

<code php>
...
	'disabled_actions' => array(
		'onBeforeAddFtp',
		'onBeforeEditFtp',
		'onBeforeDeleteFtp',
		'onBeforeAddSqlUser',
		'onBeforeEditSqlUser',
		'onBeforeDeleteSqlUser',
		'onBeforeAddSqlDb',
		'onBeforeDeleteSqlDb'
	)
...
</code>

====D. Exemple complet d'un fichier de configuration====

Un fichier de configuration pour le plugin **Demo** peut être:

<code php>
<?php
return array(
	/*
		List of user accounts that will be available via select box on login page. If an user account is protected, it
		will be imposible to remove it. Also, its password will be protected against modification.
	*/
	'user_accounts' => array(
		array(
			'label' => 'Administrator 1',
			'username' => 'admin1',
			'password' => 'admin1',
			'protected' => true
		),
		array(
			'label' => 'Reseller 1',
			'username' => 'reseller1',
			'password' => 'reseller1',
			'protected' => true
		)
	),

	/*
		List of actions that must be totally disabled. Each action must be prefixed by 'onBefore'
	*/
	'disabled_actions' => array(
		'onBeforeAddFtp',
		'onBeforeEditFtp',
		'onBeforeDeleteFtp',
		'onBeforeAddSqlUser',
		'onBeforeEditSqlUser',
		'onBeforeDeleteSqlUser',
		'onBeforeAddSqlDb',
		'onBeforeDeleteSqlDb'
	)
);
</code>

Ce fichier vie dans le répertoire [[https://github.com/i-MSCP/imscp/tree/master/gui/plugins/Demo|gui/plugins/Demo]] et est nommé  [[https://github.com/i-MSCP/imscp/blob/master/gui/plugins/Demo/config.php|config.php]].

=====II. Activation du plugin=====

Pour activer le plugin, vous devez le configurer et vous rendre dans l'interface de gestion des plugins pour mettre la liste des plugins à jour et l'activer.

**Important**

En production, ce plugin doit être protégé contre la désactivation. Pour cela, vous devez le protéger via l'interface de gestion des plugins.

=====III. Désactivation du plugin=====

Dans un premier temps, si le plugin est protéger, vous devez éditer le fichier **gui/data/persistent/protected_plugins.php** pour le supprimer de la liste des plugins protégés. Après cela, vous serez en mesure de désactiver le plugin dans l'interface de gestion des plugins.

N'hésitez pas à tester ce plugin et reporter tout bogues ou suggestion pour amélioration.
i-MSCP Documentation

User Tools

Site Tools

Page Tools
