Comment Déployer Jekyll

lien de référence (doc Jekyll)

Seul le lien officiel fait référence. Difficultés rencontrées avec le script automatique Glynn. Étude en cours et recherches de scripts SSH et rsync simples à paramétrer pour simplification et automatisation.

Du fait de la nature statique de la production générée, tous les sites construits avec Jekyll peuvent être déployés de différentes façons. Quelques-unes des techniques les plus communes sont décrites ci-dessous.

Fournisseurs d’hébergement web (FTP)

Quasiment tous les fournisseurs d’hébergement web traditionnels vous permettent de copier des fichiers sur leurs serveurs par FTP. Pour téléverser un site Jekyll sur un hébergeur web en utilisant FTP, lancez simplement la commande jekyll et copiez le répertoire _site généré sur le répertoire racine de votre compte hébergé. Pour la plupart des fournisseurs d’hébergement, ceci se fait généralement sur les répertoires httpdocs ou public_html.

FTP en utilisant Glynn

Il existe un projet appelé Glynn, qui vous permet de générer facilement vos fichiers statiques du site web motorisé par Jekyll et de les envoyer à votre hébergeur par FTP.

Par exemple, le fichier _config.yml de cette instance hébergée chez OVH se présente comme suit : {% highlight yaml %} ftp_host: ftp.christopheducamp.com ftp_username: monnomutilisateur ftp_dir: /www ftp_passive: false {% endhighlight %}

Pour générer le site et le déployer, il me suffit alors de reprendre la ligne de commande, de me placer à la racine du projet puis de taper la commande :

{% highlight bash %} $ glynn {% endhighlight %}

(C’est la solution que j’ai retenue pour le moment : une ligne de commande puis un mot de passe, et tout le site est régénéré et mis en ligne !)

Serveur web auto-géré

Si vous avez un accès direct au serveur web de déploiement, le processus est en fait le même, si ce n’est que vous pourriez disposer d’autres méthodes vous étant réservées (comme des accès scp, ou même un accès direct au système de fichiers). Souvenez-vous simplement de vous assurer que les contenus du répertoire _site généré soient placés dans le bon répertoire web racine de votre serveur web.

Méthodes automatisées

Il existe aussi un certain nombre de moyens pour automatiser facilement le déploiement d’un site Jekyll. Si vous avez une autre méthode non listée ci-dessous, nous adorerions l’ajouter si vous y avez contribué afin que tous les autres puissent aussi en profiter.

Git post-update hook

Si vous stockez votre site jekyll dans Git (vous utilisez un contrôle de version, non ?), il est vraiment facile d’automatiser le processus de déploiement en réglant un hook de mise-à-jour-post dans votre dépôt Git, comme ceci.

Git hook post-receive

Pour faire qu’un serveur distant gère le déploiement pour vous à chaque fois que vous poussez des modifications en utilisant Git, vous pouvez créer un compte utilisateur qui dispose de toutes les clés publiques qui sont autorisées pour déployer dans son fichier authorized_keys. Une fois cela mis en place, régler le hook post-receive se fait comme suit :

{% highlight bash %} laptop$ ssh deployer@exemple.com server$ mkdir monrepo.git server$ cd monrepo.git server$ git –bare init server$ cp hooks/post-receive.sample hooks/post-receive server$ mkdir /var/www/monrepo {% endhighlight %}

Ensuite ajoutez les lignes suivantes à hooks/post-receive et assurez-vous que Jekyll soit installé sur le serveur :

{% highlight bash %} GIT_REPO=$HOME/monrepo.git TMP_GIT_CLONE=$HOME/tmp/monrepo PUBLIC_WWW=/var/www/monrepo

git clone $GIT_REPO $TMP_GIT_CLONE jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW rm -Rf $TMP_GIT_CLONE exit {% endhighlight %}

Pour finir, faites tourner la commande suivante sur n’importe quel ordinateur d’utilisateur ayant besoin de déployer en utilisant ce hook :

{% highlight bash %} laptops$ git remote add deploy deployer@exemple.com:~/monrepo.git {% endhighlight %}

Déployer est maintenant aussi facile que de dire à nginx ou Apache de regarder /var/www/monrepo et de faire tourner ce qui suit :

{% highlight bash %} laptops$ git push deploy master {% endhighlight %}

Jekyll-hook

Vous pouvez aussi utiliser jekyll-hook, un serveur qui écoute les posts webhook à partir de GitHub, génère un site web avec Jekyll, et le migre quelque part ailleur pour publication. Utilisez ça pour faire tourner votre propre serveur web du style-GitHub Pages.

Cette méthode est utile si vous avez besoin de servir vos sites web derrière un pare-feu, si vous avez besoin de quelques fonctionnalités côté-serveur comme une authentification HTTP basique ou si vous voulez héberger directement votre site sur un CDN ou un hôte comme S3.

Les étapes de paramétrage sont complètement documentés dans le repo jekyll-hook.

Static Publisher

Static Publisher est une autre option de déploiement automatisée avec un serveur qui écoute les posts webhook, même si elle n’est pas spécifiquement liée à GitHub. Elle a un déploiement-en-un-clic vers Heroku, elle sait regarder plusieurs projets sur un serveur, elle a une interface-utilisateur d’admin facile et peut publier soit sur S3 ou vers un repository git (par ex. gh-pages).

Rake

Un autre moyen de déployer votre site Jekyll est d’utiliser Rake, HighLine et Net::SSH. Un exemple plus complexe de déploiement Jekyll avec Rake qui gère plusieurs branches peut être trouvé dans Git Ready.

scp

Une fois que vous avez généré le répertoire _site, vous pouvez facilement le scp en utilisant un script shell tasks/deploy similaire à ce sript deploy ici. Vous devrez évidemment ajuster les valeurs aux détails de votre site. Il existe même une commande correspondante TextMate qui vous aidera à lancer ce script à partir de TextMate.

rsync

Une fois que vous avez généré le répertoire _site, vous pouvez facilement le rsync en utilisant un script shell tasks/deploy similaire à ce script de déploiement ici. Vous devrez bien évidemment changer les valeurs pour refléter les détails de votre site.

L’autorisation basée-sur-Certificat est un autre moyen de simplifier le processus de publication. Cela a du sens de restreindre l’accès rsync uniquement au répertoire qui est supposé être synchronisé. Ceci peut être fait en utilisant rrsync.

Étape 1 : Installer sur votre répertoire home (côté-serveur)

S’il n’est pas déjà installé par votre hébergeur, vous pouvez faire ça vous-même :

  • Téléchargez rrsync
  • Placez-le dans le sous-répertoire bin de votre répertoire home (~/bin)
  • Rendez-le exécutable (chmod +x)

Étape 2 : Régler l’accès SSH basé-sur-certificat (côté serveur)

Ce processus est décrit en ligne à plusieurs endroits. Ce qui diffère de l’approche typique, c’est de placer l’autorisation basée-sur-certificat dans ~/.ssh/authorized_keys. Ensuite, lancez rrsync et fournissez-le avec le répertoire avec lequel il devra avoir accès en lecture-écriture sur :

{% highlight bash %} command=« $HOME/bin/rrsync  »,no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-rsa {% endhighlight %}

<folder> est le chemin vers votre site, par exemple, ~/public_html/you.org/blog-html/.

Étape 3 : Rsync (côté-client)

Ajoutez le script deploy vers le répertoire source du site source:

{% highlight bash %} #!/bin/sh

rsync -crvz –rsh=ssh -p2222’ –delete-after –delete-excluded @: {% endhighlight %}

Les paramètres de ligne de commande sont :

  • --rsh=ssh -p2222 — Le port pour l’accès SSH. Requis si votre hôte utilise un port différent que celui par défaut (par ex., HostGator)
  • <folder> — Le nom du répertoire output local (par défaut vers _site)
  • <user> — Le nom d’utilisateur pour votre compte d’hébergement
  • <site> — Votre serveur d’hébergement

En utilisant ce réglage, vous pourriez lancer la ligne de commande qui suit :

{% highlight bash %} rsync -crvz –rsh=‘ssh -p2222’ –delete-after –delete-excluded _site/ hostuser@example.org: {% endhighlight %}

N’oubliez pas le signe deux-points : après le nom du serveur !

Étape 4 (Facultative) : Exclure le script de transfert de la copie vers le répertoire de sortie.

Cette étape est recommandée si vous utilisez ces instructions pour déployer votre site. Si vous placez le script deploy dans le répertoire root de votre projet, Jekyll le copiera dans le dossier output. Ce comportement peut être modifié dans _config.yml.

Ajoutez simplement la ligne qui suit :

{% highlight yaml %}

Do not copy these files to the output directory

exclude: [« deploy »] {% endhighlight %}

Alternativement, vous pouvez utiliser un fichier rsync-exclude.txt pour contrôler quels fichiers seront transférés sur votre serveur.

Fait !

Maintenant, il est possible de publier votre site web simplement en lançant le script de commande deploy. Si votre certificat SSH est protégé par une phrase-passe, elle vous sera demandée au moment de l’exécution du script.

Rack-Jekyll

Rack-Jekyll est un moyen facile de déployer votre site sur tout serveur Rack tel que Amazon EC2, Slicehost, Heroku et ainsi de suite. Il peut aussi tourner avec shotgun, rackup, mongrel, unicorn, et d’autres.

Lisez ce post pour savoir comment déployer sur Heroku en utilisant Rack-Jekyll.

Jekyll-Admin pour Rails

Si vous voulez maintenir Jekyll dans votre app existante Rails, Jekyll-Admin contient un code à lâcher pour rendre ça possible. Regardez la page README de Jekyll-Admin pour plus de détails.

Amazon S3

Si vous voulez héberger votre site sur Amazon S3, vous pouvez faire ainsi avec l’application s3_website. Elle poussera votre site vers Amazon S3 où il peut être servi comme n’importe quel serveur web, pouvant dynamiquement passer à l’échelle pour du trafic presque illimité. Cette approche a l’avantage d’être parmi l’option d’hébergement la plus économique pour des blogs de gros volume, car vous ne payez que pour ce que vous utilisez.

OpenShift

Si vous souhaitez déployer votre site sur OpenShift, il y a une cartouche pour cela.

##ProTruc : Pour un hébergement Jekyll zéro-tracas, utilisez les Pages GitHub

Les Pages GitHub sont motorisées en coulisses par Jekyll, par conséquent si vous cherchez un hébergement zéro-tracas, une solution à coût zéro, les Pages GitHub sont un moyen génial pour héberger gratuitement votre site web-motorisé-par-Jekyll.

Kickster

Utilisez Kickster pour des déploiement faciles (automatisés) vers les pages GitHub si vous utilisez des plugins non supportés sur les Pages GitHub.

Kickster fournit un réglage de projet Jekyll basique avec les meilleures pratiques et des outils utiles d’optimisation pour la qualité globale de votre projet. Kickster est livré avec des scripts automatisés et sans souci pour GitHub pages.

Régler Kickster est très facile, installez simplement la gem et vous êtes prêt à partir. Plus de documentation peut être trouvée ici. Si vous ne voulez pas utilisere la gem ou démarrer un nouveau projet, vous pouvez juste copier-coller les scripts de déploiement pour Travis CI ou Circle CI.

“Comment Déployer Jekyll” a été mise à jour le :
Améliorer cette page