KitSpip : Kit Installer To SPIP fontsizeup fontsizedown

Accueil du site > Documentation publique > Créer son kit d’installation

samedi 19 mai 2007, par aris

Créer son kit d’installation

Documentation synthétique sur l’utilisation du Kit Spip, un tutoriel de prise en main rapide pour créer son propre kit en quelques étapes...

Le Kit Spip est un dispositif qui permet d’installer de façon automatisée une version de Spip personnalisée. Une fois le processus terminé, nous obtenons ainsi un site web fonctionnel qui comprend :

  • Une version préconfigurée de Spip.
  • Un contenu minimal par défaut (au minimum un compte administrateur et éventuellement des rubriques et mots clés prédéfinis...).
  • Un jeu de squelettes personnalisés (pages, modèles, formulaires, noisettes, images, etc.).
  • Une sélection de plugins, activés et déjà configurés.
  • Des fichiers optionnels de personnalisation si nécessaires (mes_options, mes_fonctions, types d’URL, etc.).

L’avantage de ce dispositif est de permettre de proposer un modèle de site web, basé sur un Spip enrichi d’une sélection d’extensions (plugins, paramètres personnalisé), et prêt à l’emploi avec un strict minimun de configuration nécessaire.

Principe de fonctionnement

Comme le Spip Loader (l’installeur officiel de Spip sur lequel il est basé), le Kit Spip repose sur une architecture client/serveur : un simple fichier de chargement (kit_loader.php), à déposer dans le répertoire où l’on désire procéder à l’installation, et qui se charge (une fois déclenché) de récupérer à distance depuis le serveur de Kit une version courante de Spip et les différents modèles et éléments de personnalisation.

En pratique, le Kit Spipt fournit une structure pour créer un processus d’installation personnalisé (et non, on l’aura compris, un script utilisable tel quel).

Pour créer son propre kit d’installation il nous faudra :

  1. Générer les différentes archives au format .zip du modèle de site.
  2. Créer un dépôt, accessible sur le web, contenant les fichiers d’installation (le serveur d’installation).
  3. Configurer un fichier de chargement (kit_loader.php), il n’y a normalement rien à faire, le système récupérant automatiquement les adresses du serveur.

Concevoir son kit

L’utilisation du kit d’installation pré-suppose d’avoir déja un jeu de squelettes fonctionnels et, éventuellement, d’avoir fait une sélection de plugins (testés au préalable biensûr).

Il nous faut ensuite installer un modèle de site, c’est-à-dire un site Spip fonctionnel et personnalisé avec nos squelettes, les plugins sélectionnés, les fichiers de configuration optionnels éventuellement nécessaires (mes_fonctions.php, mes_options.php) et tout le contenu que l’on souhaite voir installé par défaut (rubriques, mots clefs, comptes administrateurs et/ou utilisateurs, etc.).

C’est ce site qui sera en quelque sorte cloné à l’identique par le kit...

Une fois que tout est opérationnel, il nous faut générer les archives .zip nécessaires au kit à l’aide du plugin « Mes fichier » :

  • Faire une sauvegarde de la base de données (dump) via l’interface d’administration de Spip.
  • Générer l’archive .zip de tous les fichiers personnalisés du site à l’aide du plugin « Mes fichiers. » Celle-ci inclus les répertoires squelettes/ et IMG/, ainsi que le dump le plus récent de la base de donnée.

il convient ensuite de récupérer par FTP cette archive nommée mes_fichiers.zip (dans le répertoire tmp/dump/ de notre site-modèle) et de l’ntégrer au dispositif serveur de notre kit.

Si le site installé par le kit prévoit l’utilisation de plugins, l’archive compressée de chacun d’entre eux doit aussi être mise à disposition sur le serveur.

Le serveur d’installation

Le serveur de kit est constitué de trois répertoires :

INSTALL/
Contient les fichiers spécifiques au kit_loader :

  • charge_kit_loader.php : le chargeur de base qui fabrique le script d’installation kit_loader.php.
  • kit_loader.css : feuille de styles associés au kit.
  • kit_loader.js : l’hôte jQuery qui assure l’enchainement des écrans de l’installation.
  • kitspip.zip : cette archive contient le post-installeur (kit_loader_final.php) qui sera inclus par la dernière phase de l’installation et le plugin « Chargeur » qui assurera les chargements nécessaires à cette post-installation [1].

DISTRIB/
Tous les fichiers issus de la distribution standard de spip, incluant spip_loader et les plugins :

  • spip_loader.php.txt le spip_loader standard et ses outils :
    • pclzip.php.txt librairie permettant de décompresser les archives.zip (pclzip).
    • tradloader_XX.php.txt Les traductions des écrans d’installation (XX étant le code de langue).
  • spip.zip l’archive de Spip (ici une version 1.9.2a).
  • kit_loader_jquery.js et kit_loader_form.js les bibliothèques jQuery du core, ici renommées pour qu’elles soient nettoyées en fin d’installation.
  • Autres archives XXX.zip : les plugins à installer.

CONFIG/
Les éléments spécifiques à la configuration personnalisée du kit :

  • spip_extra.zip ces fichiers viennent remplacer les éléments d’origine du core. Certains sont nécessaires à kit_loader :
    • spip/tmp/cache/ : le répertoire tmp/cache est normalement créé à la volée par spip, mais certaines configurations serveurs posent problème.
    • spip/ecrire/install/etape_6.php afin de connecter la post-installation kit_loader_final.php
    • spip/ecrire/inc/import.php pour forcer le retour de l’import de données sur spip.php et non self().
  • mes_fichiers.zip l’archive du contenu personnalisé réalisée à partir du site modèle.

Liens utiles

Télécharger les archives .zip des plugins stables
http://files.spip.org/spip-zone/

Notes

[1] A noter que ce plugin « chargeur » est le seul élément qui restera installé. On peut s’en servir ultérieurement pour charger d’autres plugins ou squelettes.

Répondre à cet article

34 Messages de forum


Suivre la vie du site RSS 2.0 | Plan du site | Espace privé | SPIP | squelette