Téléchargement Chappy - Téléchargement du code source Chappy

Chappy

Autre code source

1.0.0

Télécharger

Chappy

Chappy est le moyen le plus simple de déployer des sites Web à l'aide de GitHub WebHooks.

Définissez un script de projet et de déploiement pour s'exécuter et Chappy écoutera les modifications de votre dépôt GitHub et déploiera automatiquement. Il est parfait pour les déploiements à petite échelle comme un seul serveur DigitalOcean ❄️

Guide de démarrage rapide

Télécharger

Système opérateur
Linux x64
Maxos (10,7 et plus)
Windows x64
Windows x32

Il existe plus d'options pour différents types de systèmes d'exploitation dans le dossier build .

Installation

Pour commencer, téléchargez l'exécutable correct pour votre système d'exploitation et déplacez-le vers un répertoire dans votre $PATH . Par exemple sur Linux x64:

$ mv chappy-linux-amd64 chappy
$ chmod +x chappy
$ sudo mv chappy /usr/local/bin/chappy

❓ Questions? Vous pouvez lire les instructions d'installation étape par étape pour Linux, Mac et Windows.

Créer un projet

L'étape suivante consiste à créer un fichier de projets qui définira les webhooks que vous souhaitez servir pour un ou plusieurs repos. Tout d'abord, créez un fichier projects.json vide dans votre répertoire à domicile ou www. Définissons un projet nommé MyWebsite qui exécutera un script de déploiement situé dans /var/www/MyWebsite/deploy.sh .

[
  {
    "name" : " MyWebsite " ,
    "branch" : " master " ,
    "script" : " /var/www/MyWebsite/deploy.sh " ,
    "secret" : " <SECRET> "
  }
]

? Pour vous assurer que seul GitHub peut exécuter votre webhook, chaque projet doit avoir une chaîne secrète unique. Vous pouvez générer rapidement une chaîne aléatoire de 32 caractères en exécutant chappy secret ou utiliser un générateur de mots de passe aléatoire - de toute façon, assurez-vous de remplacer <SECRET> .

Création d'un script de déploiement

Votre script de déploiement doit être un script exécutable (assurez-vous de chmod +x deploy.sh ). À sa forme la plus basique, il devrait exécuter git pull , pour mettre à jour le dépôt avec les dernières modifications. L'exemple ci-dessous installe toutes les nouvelles dépendances avec Composer et NPM et reconstruit les actifs à l'aide de Gulp.

 #! /bin/bash
git pull
composer install
npm install
gulp --production

Les arguments avec les détails de l'événement sont transmis au script, qui peuvent être utilisés pour exécuter les commandes dynamiquement. Il existe des exemples de script de déploiement plus avancés sur la page de script de déploiement qui montrent comment utiliser cette fonctionnalité.

Vous pouvez maintenant commencer Chappy en utilisant

$ chappy start

⚙ Vérifiez la page CLI pour voir une liste des commandes disponibles, comment configurer l'IP et le port sur lesquels Chappy s'exécute et activer d'autres paramètres comme le rechargement chaud du fichier de projets ou le service sur HTTPS.

Créer le webhook

Ajoutez un nouveau webhook à votre dépôt github, qui peut être trouvé dans les paramètres -> webhooks -> Ajouter webhook.

Par défaut, l'URL de charge utile sera votre serveur IP, le port 9000, puis le nom de votre projet. IE http://123.456.0.1:9000/MyWebsite .
Un type de contenu d' application/json est recommandé mais il peut en être.
Le secret devrait être la chaîne secrète que vous avez définie dans projects.json .
L'événement que vous devez écouter est juste l'événement push .

Essai

⏰ À venir bientôt - Chappy se connectera à un fichier vous permettant de savoir si quelque chose ne va pas - et écoutez l'événement GitHub ping pour sauter en train de faire un test.

Pour tester tout ce qui fonctionne avec succès, faites un test de demande ou de la demande de traction vers la branche principale ( "Beep, Boop! - Testing Chappy ?" Fera très bien).

Si le webhook se termine sans erreurs et que votre script s'exécute correctement, alors félicitations ?! S'il y a des erreurs, veuillez lire la page de dépannage ou soumettre un problème. ?