Mises à niveau de Sitecore: une mini-série partie 3 Patching Sitecore.Config

Qu'est-ce que le correctif?

La meilleure pratique de nos jours est de garder votre fichier Sitecore.config complètement intact. Ne modifiez pas directement les paramètres trouvés ici. N'ajoutez pas non plus de nouveaux paramètres. L'application de correctifs vous permet de modifier les paramètres existants et d'ajouter de nouveaux paramètres à Sitecore.config sans jamais toucher directement le fichier Sitecore.config lui-même. Le correctif vous aidera à déterminer si quelque chose ne va pas avec votre instance en raison du processus de nouvelle installation ou en raison des paramètres personnalisés nécessaires pour votre solution particulière. Cela facilitera également les mises à jour ultérieures en déplaçant tous les changements personnalisés ailleurs.

Comment corrigez-vous?

Créez simplement un fichier de configuration qui sera déployé dans le dossier App_Config. Toutes vos modifications personnalisées ne pas doivent être dans un seul fichier de correctif. Vous pouvez créer autant de fichiers de correctifs que vous le souhaitez. Ma recommandation est de suivre les meilleures pratiques Helix ici. Si vous corrigez un nouveau paramètre lié à quelque chose de fondamental, vous devez le corriger dans la zone App_Config / Foundation.

Jetons un coup d'œil à un exemple de fichier de correctif. Voir le code ci-dessous:

Quand ceci est déployé, Sitecore recherchera le nœud . Il ajoutera ensuite ce configurateur au nœud . Si un nœud n'était pas trouvé, il en créerait un dans Sitecore.config. Si vous devez exécuter un certain processus avant un autre, vous pouvez spécifier de le patcher à une certaine position avec des attributs tels que patch: before ou patch: after. Vous pouvez en savoir plus à ce sujet dans la documentation de Sitecore ici .

Création de fichiers de correctif pendant le processus de mise à niveau

Si votre solution fonctionne déjà bien utilisation des correctifs, vous n'aurez probablement pas à vous soucier de faire quoi que ce soit dans ce billet de blog. Vous avez de la chance. D'autres pas tellement. Si votre solution ne fait pas de correctifs, vous voudrez aller de l'avant et prendre le relais pendant le processus de mise à niveau. Pour introduire correctement les correctifs, je recommande vivement de télécharger un outil de comparaison de texte comme Beyond Compare .

Dans votre version Sitecore actuellement en ligne, accédez à /sitecore/admin/show_config.aspx dans votre navigateur. Copiez tout le XML qui s'y trouve. Ensuite, effectuez une comparaison de texte pour trouver les différences entre le Sitecore.config personnalisé et un nouveau Sitecore.config intact pour la même version de Sitecore. Lorsque vous corrigez une solution pour la toute première fois lors d'une mise à niveau, je vous recommande de créer un fichier de configuration pour héberger tous les paramètres que vous corrigez. Vous pouvez enregistrer la séparation du fichier de correctif en plusieurs fichiers en tant qu'activité postérieure à la mise à niveau.

Après avoir créé ce fichier de correctif contenant tous les paramètres personnalisés, vous pouvez le déployer sur votre nouvelle installation de la version de Sitecore vers laquelle vous effectuez la mise à niveau. Après cela, vous pouvez rencontrer plusieurs erreurs de DLL manquantes, etc. Une fois que vous avez déployé votre code mis à jour (plus tard dans cette série), vous pouvez alors voir si Sitecore continue de ne pas se charger dans le navigateur. Si vous ne parvenez pas à comprendre pourquoi il ne s’affiche pas, essayez de supprimer le fichier de correctif déployé. Vérifiez ensuite que Sitecore apparaît. Si tel est le cas, ajoutez à nouveau le fichier de correctif, mais en n'ajoutant qu'un seul paramètre personnalisé à la fois jusqu'à ce que vous trouviez le paramètre qui cause l'échec de Sitecore.

Échec de l'accès à la page show_config

Si vous avez extrait le solution à votre local et ne peut pas accéder à la page show_config.aspx car vous n'avez pas d'accès administrateur, il existe une solution de contournement. Dans vos fichiers déployés, recherchez la page unlock_admin.aspx sous sitecore / admin. Copiez ce fichier et placez-le sous le dossier sitecore. La raison de ce déplacement est que tout ce qui se trouve dans le dossier admin nécessite que vous soyez authentifié en tant qu'administrateur pour y accéder. Ensuite, ouvrez ce fichier. Vous devrez apporter quelques modifications. Vous trouverez ci-dessous deux extraits de code montrant ce que sont certaines lignes avant les modifications et ce à quoi elles doivent être modifiées.

 // BEFORE
booléen privé enableUnlockButton = false;

// APRÈS
private bool enableUnlockButton = true; 

 // AVANT
Membership.GetUser ("sitecore \ admin"). UnlockUser ();

// APRÈS
var user = Membership.GetUser ("sitecore \ admin");
user.UnlockUser ();
user.ChangePassword (user.ResetPassword (), "b"); 

Après avoir enregistré ces modifications, accédez à /sitecore/unlock_admin.aspx. Cliquez sur le bouton de déverrouillage pour réinitialiser le mot de passe de l’utilisateur administrateur sur «b». Ne faites cela que dans votre environnement local. Ne faites pas cela dans les environnements supérieurs. Cela poserait un risque majeur pour la sécurité si vous faisiez cela dans un environnement supérieur accessible au public.