Club Drupal

h1. Création d'un sous site

{{>toc}}

NB : pour créer un site (entre autres), vous aurez besoin de vous connecter au compte assos en ssh. Pour cela utilisez soit le terminal (<code> ssh assos@sas1.centrale-marseille.fr</code>) soit une interface graphique (cf "les tuto sur le site du Ginfo":http://assos.centrale-marseille.fr/ginfo/content/linux-avoir-acc%C3%A8s-%C3%A0-mon-r%C3%A9pertoire-depuis-chez-moi).

h2. Méthode Drupal 7

{{important(La méthode est susceptible de changer régulièrement à cause des redirections variées. Lire le paragraphe suivant et voir avec le CRI (dgeo) si la méthode est périmée.

Pensez également à tenir le script de création de site à jour.)}}

h3. Création du site drupal 7

# Vérifier qu'il n'y a pas de fichiers modifiés/ajoutés en attente avec @git status@

# Dans htmltest/sites créer un nouveau dossier nommé _assos.centrale-marseille.fr.nomdusite_. Le _nomdusite_ doit faire moins de 16 caractères et en pas contenir le caractère '-'. Ce sera ce qu'on appelle par la suite le dossier du site.

# Créer ce qu’il faut pour les sauvegardes :

## Créer deux dossiers pour les sauvegardes individiuelles (automatiques et manuelles)

## Créer trois fichiers de la forme @$d7_dir_individual_auto_backup/$dir_site_name/$current_date.$dir_site_name.sqlx@ pour que le script de purge des sauvegardes ne gueule pas.

## Par exemple :

<pre><code class="php">for i in {1..4} ; do

  touch auto/d7/assos.centrale-marseille.fr.camara/`date "+%Y-%m-%d-%Hh%Mm%Ss"`.assos.centrale-marseille.fr.camara.sql$i

done</code></pre>

# Se connecter sur phpmyadmin sur le serveur myassos (dans la liste déroulante) avec le login assos (le mdp est dans accessible via la forge).

# Créer une nouvelle base de donnée et un nouvel utilisateur nommés _nondusite_ via User > add user.

## Renseigner son nom.

## Générer un mot de passe aléatoire et le conserver (il est à renseigner dans le settings.php).

## Dans _database for user_, cocher _Create database with same name and grant all privileges_.

## Laisser toutes les autres options par défaut.

## Valider

# On configure le settings.php qui contient toutes les variables indispensables au bon fonctionnement de drupal.

## Copier-coller le fichier d7-settings.php (présent dans le dossier template) dans le dossier du site.

## Renommer ce fichier en settings.php (il contient seulement deux lignes de code. Elles importent le settings.global.php qui contient les infos communes à tous les sites et settings.local.php qui contient les infos spécifiques à chaque sites)

## Copier-coller le fichier d7-settings-local-template.php

## Renommer ce fichier en settings.local.php (il contient les infos sur la base de données)

## Remplacer %%DBUSER%%, %%DBNAME%% et %%SITE_NAME%% par _nomdusite_

## Remplacer %%DBPASS%% par le mot de passe généré ci-avant.

# Ajouter à la fin du fichier sites.php la ligne : @$sites['assos.centrale-marseille.fr.NOMDUSITE'] = 'assos.centrale-marseille.fr.NOMDUSITE@ ou si l’url est différente, remplacer le @'assos.centrale-marseille.fr.NOMDUSITE'@ de gauche par celle-ci.

# Ajouter dans le fichier ~/.drush/aliases.drushrc.php la ligne correspondant au site :

## dans 'site-list' : @'assos.centrale-marseille.fr/$site_name',@

## à la fin du fichier : @$aliases['$site_name'] = array('uri' => 'assos.centrale-marseille.fr/SITE_NAME', 'root' => '/users/guest/assos/htmltest/', );@

# Lancer l'installation du site en allant sur l'url : http://assos.centrale-marseille.fr/nomdusite/install.php Si la page obtenue affirme que le site est déjà installé, c'est qu'il y a une erreur dans les étapes précédentes : recommencer scrupuleusement.

# Choisir la langue (de préférence le français) et continuer l'installation en donnant un nom  pour le site (également configurable après) et en créant un compte pour l'administrateur.

# Lancer le script _d7-reset-variables.sh_ dans le dossier du site.

# Mettre les bons droits sur les dossiers/fichiers entrer ces commandes dans le répertoire htmltest/sites

## chmod -R 755 DOSSIER_DU_SITE

## chmod 400 DOSSIER_DU_SITE/settings.php

# Commiter les changements pour qu'ils soient pris en compte dans git : @git commit -a -m "Creation of site: $d7_site_name"@

{{tip(Des statistiques sont accessibles via https://piwik.centrale-marseille.fr/. Voir le club Drupal pour les accès. Si c'est un site d'association, voir avec dgeo pour créer un piwik id. Sinon, seuls les blogs avec du contenu et certains sites particuliers peuvent avoir droit à cet id.)}}

h3. Trucs à faire sur le site juste après l’ouverture du site drupal 7

* Conseiller à l'administrateur de ne pas laisser les inscriptions ouvertes à son site

* Donner à l'administrateur le lien des tutoriels écrits par le club Drupal

* Créer un contenu de type "Site" sur la page du projet multiassos

* Inscrire à la liste de diffusion webmasters@listes.centrale-marseille.fr

h2. Script de création de site drupal 7

Un script de création de site est également disponible sur le bureau de assos. Il prend le nom du site à créer en paramètre. Ensuite, suivez les instructions.

Concernant le fonctionnement du script, il doit respecter à la lettre la méthode précédente. Si ce n’est pas le cas, se renseigner sur la méthode à suivre et mettre à jour en conséquence. Voir les commentaires dans le script pour de plus amples informations.

h2. Quelques informations sur le pourquoi du comment

Si la méthode est périmée, voici quelques informations pour la réparer (se rapprocher de dgeo en cas de souci).

Lorsqu'un site est appelé avec l'url http://assos.centrale-marseille.fr/nomdusite, les actions suivantes sont effectuées :

* Se rendre dans html (ou htmltest) et chercher un dossier nommé _nomdusite_. C'est la raison pour laquelle il faut avoir un lien symbolique dans html nommé _nomdusite_.

* Si le dossier n'est pas trouvé, c'est foutu, sinon, rentrer dedans ; en l'occurrence, suivre le lien symbolique qui ramène vers ... html !

* Une fois dans ce dossier (donc toujours dans html), chercher un fichier <code>index.php</code>

* S'il n'est pas trouvé, c'est foutu, sinon le lire. En l'occurrence, ce fichier est présent dans html et créé par Drupal. On rentre donc dans le champ d'action de drupal

* Chercher dans l'installation drupal un dossier nommé assos.centrale-marseille.fr.nomdusite

* Si trouvé, rentrer dedans et lire le <code>settings.php</code>

* Si tout va bien, afficher le site :)

Les 4 premières sont dues à la structure du serveur fourni par le CRI (Le lien symbolique dans html n'est donc pas forcément nécessaire si on installe drupal sur un autre serveur par exemple).

Le reste est du domaine de drupal.

h1. Suppression d'un sous site

# Vérifier qu'il n'y a pas de fichiers modifiés/ajoutés en attente avec @git status@

# Supprimer la base de données du site et l’utilisateur dans phpmyadmin, via l’onglet _Users_ :

## Trouver l’utilisateur

## Dans _ Remove selected users_, cocher _Drop the databases that have the same names as the users._

## Valider

# Supprimer le dossier créé dans htmltest/sites en se redonnant les droits (si nécessaire)

# Supprimer la ligne du site dans le sites.php

# Supprimer les deux lignes du site dans .drush/aliases.drushrc.php

# Supprimer les sauvegardes de base données

** dans individual/auto/d7/NOM_DU_SITE

** dans individual/manual/d7/NOM_DU_SITE

# Actualiser les informations sur la liste des sites administrés : Éditer le type de contenu site et cocher _État du site_

# Commiter les changements pour qu'ils soient pris en compte dans git : @git commit -a -m "Deletion of site: $d7_site_name"@

{{note(Les utilisateurs se retirent eux même de la liste webmaster)}}

h1. Installation de module ou de thème

NB : du fait de l'installation en multi-site, un projet (module ou thème) installé est un projet installé pour **tous** les sites de l'installation.

Pour installer un projet uniquement pour un sous-site, il faut créer un dossier themes ou modules (selon le cas) dans le dossier du site, et effectuer l'installation dans celui-ci à la place du dossier all/modules.

Mais attention, cela rend le multi-site compliqué à maintenir, c'est donc à éviter à tout prix. Seuls certains cas très particuliers (et qui doivent être documentés pour qu'on en garde la trace) bénéficieront de ce traitement !

h2. Installation de module/thème à la main

* Se rendre sur le site officiel de Drupal sur la page du projet

* Télécharger la source

* L'extraire

* Placer le dossier extrait dans le dossier sites/all/modules ou sites/all/themes en fonction du cas

* **Si** le dossier extrait comprend un fichier INSTALL.txt, le lire et suivre les éventuelles étapes complémentaires

* Se connecter en tant qu'admin sur n'importe quel site du projet et vérifier que le nouveau module ou thème est installé.

h2. Installation de module/thème drush

[[drush|Quelques explications sur Drush avant ?]]

* Se rendre dans le dossier d'un site de l'installation via son terminal

* Taper la commande <code>drush dl projet</code> (où projet est le nom du thème ou module)

* Activer sur un site le nouveau module ou thème pour vérifier que ça marche bien <code>drush en projet</code>

h1. Suppression de module ou de thème

Pour cela, le plus simple est d'utiliser le script d7-all-drush.sh.

Il faut :

# désactiver le projet sur tous les sites : <code>d7-all-drush.sh dis projet</code>

# désinstaller le projet sur tous les sites (c'est-à-dire supprimer toutes les tables dans la base de données qui ont été créées par le projet) : <code>d7-all-drush.sh pm-uninstall projet</code>

# supprimer le dossier du projet dans le répertoire sites/all/modules ou sites/all/themes

# vérifier que le module n'avait pas besoin d'une librairie dans le répertoire sites/all/libraries, la supprimer si besoin.

h1. Mises à jour

{{warning(

Attention | Il ne faut jamais renommer les modules et thèmes en vue de les sauvegarder ! Les sauvegardes doivent toujours se faire à l'extérieur du répertoire accessible par web ! Il en est de même pour les sauvegardes des bases de données.

)}}

Les mises à jour permettent de conserver une version récente et maintenue du code utilisé. Elles doivent donc être faites aussi régulièrement que possible, surtout si elles corrigent des failles de sécurité. Un site qui n'est pas à jour est potentiellement un site vulnérable !

On distingue plusieurs types de mises à jour :

* les mises à jour de projet (projet = module ou thème)

* les mises à jour du noyau (core) de drupal

* les mises à jour majeures de drupal (migration)

* les mises à jour de la base de données : il s'agit en fait d'une étape dans les précédents types de mises à jour

NB : à l'exception des mises à jour de la base de données (qui sont faites uniquement dans les tables des sites concernés), les mises à jour faites pour un site sont valables pour tous les sites de l'installation : c'est le principe du multi-site ;)

h2. Mise à jour d'un module ou d'un thème

Pour notre installation drupal 7, il faudra effectuer quelque chose de similaire.

Voici tout de même les méthodes pour effectuer ces mises à jour.

Toujours privilégier la méthode drush, les autres sont présentes uniquement pour info (ou si drush est planté :p)

h3. Mise à jour d'un module ou d'un thème à la main

# Télécharger la nouvelle version du module ou du thème sur le site officiel et extraire le fichier sur le bureau du compte assos.

# Supprimer l'ancienne version dans /users/guest/assos/html/sites/all/modules.

# Copier la nouvelle version dans /users/guest/assos/html/sites/all/modules.

# Faire la mise à jour de la base de données

h3. Mise à jour d'un module ou d'un thème avec drush

[[Drush|Quelques explications sur Drush avant ?]]

Drush permet d'effectuer pour un site toutes les mises à jour des modules et des thèmes d'un seul coup.

Rappel :

* Pour effectuer cette opération sur tous les sites, remplacer drush par d7-all-drush.sh. Pour les sites drupal 7, remplacer d7-all-drush.sh par d7-all-drush.sh.

* Pour mettre un jour un site en particulier, se placer dans le dossier du site en question.

Voici comment procéder :

# se placer (dans un terminal évidemment) dans le dossier du site

# lancer la commande <code>drush -y en update</code> pour activer la mise à jour

# lancer la commande <code>drush upc --no-core</code>

# si une mise à jour de la base de données est requise, lancer la commande <code>drush -y updb</code>

# s'il y avait des mises à jour de thème, nettoyer le cache pour que les modifications soient prises en compte. Lancer la commande <code>drush cc all</code>

# lancer la commande <code>drush -y dis update</code> pour désactiver le module update

NB : la commande <code>drush up</code> permet d'effectuer upc et updb en une seule fois !

h2. Mise à jour du noyau de Drupal

Il s'agit par exemple de passer de drupal 7.X à drupal 7.Y

h3. Mise à jour du noyau de Drupal à la main

La méthode la plus complète est donnée dans le fichier UPGRADE.txt dans le dossier officiel de Drupal.

Voici tout de même une méthode un peu plus simple et qui a bien marché pour toutes les mises à jour depuis Drupal-6,9 jusqu'à Drupal-6,13

# Faire une sauvegarde complète (base de données et dossiers)

# Revenir au thème de base Garland (si ce n'est déjà pas le cas) le temps de transférer les mises à jours.

# On télécharge Drupal-6,13 à partir du site officiel http://drupalfr.org/ ou à partir du tableau de bord http://assos.centrale-marseille.fr/?q=admin/reports/status puis on décompresse le fichier.

# On copie tout le contenu du dossier "Sites" de Drupal-6,12, à savoir les dossiers "all" et "default" dans le dossier "Sites" de drupal-6,13, on écrasera donc les anciens dossiers "all" et "default" .

# Changer tout de suite les droits d'accès au fichier settings.php qui est dans sites/default en enlevant tout les droits d'accès à ce fichier (les droits maximum : 700 les droits minimun : 000). En fait le fichier sites/default/settings.php contient le mot de passe de la base de donnée il faut donc particulièrement faire attention aux droits d'accès de ce fichier.

# Copier le contenu du dossier _modules_ de Drupal-6,13 dans le dossier _modules_ de Drupal-6,12. De cette façon les modules de base de l'ancien drupal seront écrasés (et donc mis à jour) et on garde les modules complémentaires.

# Lancer le script de mise à jour de la base de données.

# Revenir au thème personnalisé du site (si ce n'est pas Garland).

# Supprimer CHANGELOG.TXT de l'installation

# Mettre à jour les settings.php

# Commiter les changements.

{{Important(Ne pas oublier de commiter les changements.)}}

h3. Mise à jour du noyau de Drupal avec drush (recommandé)

Drush permet aussi d'effectuer ce type de mise à jour.

Rappel :

* Pour effectuer cette opération sur tous les sites, remplacer drush par d7-all-drush.sh (d6-all-drush.sh pour drupal 6).

* Pour mettre un jour un site en particulier, se placer dans le dossier du site en question.

Pour ceci :

# Faire une sauvegarde complète (base de données et dossiers)

# Effectuer la mise à jour des projets

# Lancer la commande <code>drush -y en update</code> pour activer l'update sur tous les sites.

# Lancer la commande <code>drush upc drupal</code>

# Lancer <code>drush updb</code> pour faire la mise à jour de la base de données.

# Lancer la commande <code>drush -y dis update</code> pour désactiver l'update sur tous les sites.

# Penser à remettre la traduction en Français ! (Voir paragraphe ci-dessous [[Utilisation_de_Drupal_multi-site#Gestion-des-traductions-en-français|Gestion des traductions en français]])

# Mettre à jour les settings.php

# Commiter les changements.

{{Important(Ne pas oublier de commiter les changements.)}}

h3. Mise à jour des settings.php

À presque chaque version mineur de drupal, de nouvelles variables de configuration sont ajoutées au settings.php de drupal. Il faut se tenir à jour, dès lors que certaines de ces variables concernent la sécurité. Le dossiers de chaque site contient :

* settings.php : fichier qui contient toutes les variables communes à tous les sites, c’est lui que l’on va mettre à jour.

* settings.local.php : fichier qui contient les variables spécifiques à un site en particulier (information sur la base de données et base url). Hors cas particulier, il n’est jamais modifié.

Pour mettre à jour un settings.php, il faut :

# Récupérer le nouveau settings.php

# Comparer le nouveau et l’ancien (via diff, meld,…) : il faut en effet conserver les variables personnalisées de l’ancien et regarder ce qui change afin qu’on le prenne en compte.

# Supprimer du nouveau les informations spécifiques à un site :

** base_url

** Information de base de données

# Remplacer tous les settings.php (à la main ou via le scripts @d7-all-update-settings.sh@.

h2. Mise à jour Majeure

Une mise à jour majeure consiste à passer par exemple de drupal 6 à drupal 7. On parle aussi d'ugrade ou de migration.

Attention, c'est une tâche lourde qui nécessite de la préparation ! **beaucoup** de préparation (au moins 6 mois !)

Elle peut être particulièrement difficile si on possède beaucoup de projets, car s'ils existent pour drupal 6, ils ne sont pas forcément maintenus également en drupal 7 !

Voici la page de préparation de migration [[De Drupal6 vers Drupal7]]

h2. Mise à jour de la base de données

Lorsque la mise à jour d'un projet ou du noyau modifie la structure de la base de données, il faut en effectuer une mise à jour également.

h3. Mise à jour de la base de données avec drush

Il suffit de lancer, dans le dossier du site, la commande <code>drush updb</code>

h3. Mise à jour de la base de données à la main

Cette méthode utilise directement l'interface de drupal.

Il faut se rendre à l'adresse monsite/update.php et suivre les instructions.

Attention, par défaut seul le tout premier administrateur du site (c'est-à-dire le premier utilisateur, avec un uid 1 dans la base de données) peut effectuer cette opération.

S'il a été supprimé, il faut modifier le settings.php pour permettre à n'importe qui de lancer le script d'upgrade de la base de données. Attention à remettre les paramètres par défaut après.

En cas de doute, utiliser plutôt drush :p

h1. Gestion des traductions en français

h2. Méthode adoptée depuis D7

À l'installation d'un site D7, (c'est à dire pendant le install.php) la langue française doit pouvoir être proposée par défaut, si ce n'est pas le cas, c'est qu'il manque le fichier de traduction supprimé probablement lors des mises à jour du core D7. Dans ce cas :

# Aller à http://localize.drupal.org/translate/languages/fr et télécharger le fichier .po de la dernière version drupal.

# Copier ce fichier dans profiles/standard/translations

# Renommer le fichier en fr.po

# Recharger la page d'installation, la langue française doit maintenant être disponible.

Exemple : 

<pre>

<code class="bash">

cd profiles/standard/translations

wget http://ftp.drupal.org/files/translations/7.x/drupal/drupal-7.13.fr.po

</code>

</pre>

h2. Ancienne méthode manuelle

Pour traduire un site, l'administrateur devra suivre le tutoriel : http://assos.centrale-marseille.fr/content/tutoriel/traduire-linterface-de-mon-site-en-fran%C3%A7ais

h2. Maintenir les mises à jour des traductions

Du coté assos, un tâche planifiée cherche régulièrement si les traductions des sites sont à jour et sinon les met effectivement à jour (cf le crontab de assos)

h1. Changer le mot de passe de la base de données

Pour les sites ayant une base de données séparée, il faut distinguer deux choses :

* Le mot de passe du assos. Ce compte sert à l’administration. Il a les droits pour créer, supprimer une base de données, gérer les utilisateurs… Le mot de passe associé n’est connu que par les membres du club drupal. Il peut être changé de temps en temps, mais doit être changé s’il a fuité.

* Le mot de passe du site. Chaque site a en effet un utilisateur et un mot de passe pour accéder à sa base de données. Le mot de passe est inscrit dans le settings.php mais n’est vraisemblablement connu par personne. Ne doit être changé que s’il a fuité.

h3. Mot de passe du compte assos

Pour changer ce mot de passe, suivre les étapes :

# Se connecter au serveur de base de données myassos (via phpmyadmin ou en ligne de commande).

# Changer le mot de passe (se renseigner sur la procédure/commande avant).

# Prévenir les membres du club que le mot de passe a changé.

# Mettre à jour le fichier phpmyadmin.txt

h3. Mot de passe d’un site

Pour changer ce mot de passe, suivre les étapes :

# Se connecter au serveur de base de données myassos (via phpmyadmin ou en ligne de commande).

# Changer le mot de passe (se renseigner sur la procédure/commande avant).

# Modifier le settings.php (la partie de connexion à la base de données. Le script [[Scripts_et_taches_planifiees#dumpsh-and-co|chmdp.sh]] ne devrait pas être utilisé)

h1. Les scripts et tâches automatiques

Afin de gagner du temps et d'éviter les erreurs humaines, des scripts ont été écrits tout au long du projet. Certains sont même exécutés automatiquement toutes les semaines.

[[Scripts_et_taches_planifiees|La page suivante]] contient une documentation succinte du rôle de chacun.

h1. Administration plus avancée

h2. Récupérer le nom de domaine officiel d'une association/club/service

h3. En quoi ça consiste ?

Une association possède un site en assos.centrale-marseille.fr/monasso et veut récupérer l'adresse monasso.centrale-marseille.fr.

Le but est de faire pointer la première adresse vers la seconde.

h3. Solution officielle

Elle permet de changer complètement l'adresse du site.

Pour drupal7, se reporter au mail reçu par assos dont l'expéditeur est [[Noémie Lehuby]] le 28/02/2012.

h3. Solution rustine (à éviter)

Elle consiste en une redirection php :

On met le code suivant dans le index.php de monasso.centrale-marseille.fr

<pre>

<code class="php">

<?php		

		header( "Status: 301 Moved Permanently", false, 301);

		header("Location: http://assos.centrale-marseille.fr/monasso");

		exit();  

?>

</code>

</pre>

Quand on va alors sur : http://monasso.centrale-marseille.fr, l'url est réecrite  http://assos.centrale-marseille.fr/monasso

Inconvénient: en naviguant sur le site c'est l'url http://assos.centrale-marseille.fr/monasso que les internautes voient et non http://monasso.centrale-marseille.fr

h2. Personnalisation du settings.php

Il est possible de forcer la valeur de certaines variables drupal via le settings.php pour acter des configurations particulières. Pour ce qui touche à tous les sites, utiliser le fichier settings.global.php du dossier site. Pour les infos spécifiques, éditer le settings.local.php du dossier du site en question.

Cependant, pour des soucis de performances et de maintenabilité, depuis début 2012, on évite de le faire, on conserve un settings.php aussi proche que possible de sa structure officielle et on modifie les variables en utilisant drush. [[Scripts_et_taches_planifiees#la-réinitialisation-des-variables-dangeureuses|Plus d'info ici]]

La suite est laissée pour info, mais n'est plus valable !

h3. Gestion du cache

La team a remarqué que les webmaster ne réglent le cache de leur site que très rarement.

Lors du Drupal&Drink du 17/03/2011, la décision a été prise d'imposer le cache de base de Drupal dans le fichier setting.php des sites.

Désormais le fichier setting.php du Desktop dont on part toujours pour la création rapide d'un site contient les lignes suivantes :

<pre>

<code class="php">

/* ajout pour les caches */

//$conf['block_cache'] = 1;

$conf['cache'] = 1; // 1 is normal cache mode

$conf['cache_lifetime'] = 86400; // 0 is infinite

</code>

</pre>

Attention, les sites existant avant cette date n'ont pas ces lignes dans leur fichier setting.php

h3. Ne pas autoriser la mise à jour des modules via l'interface web

D7 autorise la mise à jour de modules, installation de nouveaux modules depuis l'interface d'administration pour un profil qui en a le droit et pour une configuration serveur particulière.

Pour enlever ce droits aux administrateurs des sites, il suffit d'ajouter cette ligne au fichier settings.php

<code class="php">

$conf['allow_authorize_operations'] = FALSE;

</code>

h1. Création de site : nom de dossier

* la personne ou asso qui demande un site veut une URL en assos.centrale-marseille.fr/monsite ou n'a pas d'URL en tête

** nom du dossier du site : assos.centrale-marseille.fr.monsite

* la personne ou asso qui demande un site veut une URL en monsite.centrale-marseille.fr :

** nom du dossier du site : assos.centrale-marseille.fr.monsite

** un lien : monsite.centrale-marseille.fr -> assos.centrale-marseille.fr.monsite