Github auto-deploy

Github auto-deploy

Mise en place d'une solution simple d'auto-deploy basée sur Github. Le plus complexe est sans doute d'avoir accès à SSH et d'installer Git sur votre serveur. Si cela est déjà fonctionnel, le reste sera un jeu d'enfant !

Installer Git sur le serveur.

Suivez les instructions de votre fournisseur d'hébergement. Dans le cas de MediaTemple : https://mediatemple.net/community/products/dv/204645270/installing-git

Créer un Personnal access token sur votre compte Github

Ensuite, créez un compte d'accès à vos repositories. Ceux-ci servent à remplacer votre mot de passe de manière sécurisée lors des requêtes sur HTTP. La création de token peut être faite à l'adresse suivante :

https://github.com/settings/tokens

Clone du repository sur le serveur

Connectez-vous à votre serveur par SSH et exécuter le clone initial du repository :

git clone YOUR_REPO_URL

Créer le fichier github.php

Sur le serveur, créer un fichier github.php accessible par HTTP au même niveau que le repository cloné. Le fichier doit avoir ce contenu :

<?php 

// Copy and paste the results from `passgen` here
$salt = '';
$pass = '';
// End copy and paste

// Defaults
$projectName = ''; // Your project name
$email       = ''; // Email address you want pull notifcations to go to
$from        = 'no-reply'; // Who the email, when called, is sent "from"

// Get varibles from query string
if ( isset($_GET['project']) && $_GET['project'] ) $projectName = $_GET['project'];
if ( isset($_GET['email']) && $_GET['email'] )     $email = $_GET['email'];
if ( isset($_GET['from']) && $_GET['from'] )       $from = $_GET['from'];

// Don't need to edit these lines
$remoteIP = $_SERVER['REMOTE_ADDR'];
$msg      = 'Request came form '.$remoteIP.' - http://whois.arin.net/rest/ip/'.$remoteIP;
$headers  = 'From: '.$from.' <'.$from.'@github.com>';

if (isset($_GET['update'])) {

    // We want to update the folder with the latest from the repo
    $check = md5(crypt($_GET['update'], $salt));

    if ($pass === $check) {

        // what does the pull
        $output = shell_exec('git pull 2>&1');

        if ( $output ) {
            if($email) {
                // Email to say it's successful
                mail($email, '['.$projectName.'] `git pull`', $output."\r\n".$msg, $headers);
            }
            echo "Success : " . $output;
        } else {
            if ( $email ) {
                // We didn't get output so an error occured
                mail($email, '['.$projectName.'] `git pull` error', 'No output'."\r\n".$msg, $headers);
            }
            echo "Error : " . $output;
        }

    } elseif ( $email ) {

        // Email to say the pull failed (due to wrong pass)
        mail($email, '['.$projectName.'] `git pull` password fail', $output."\r\n".$msg, $headers); 

    } else {
        echo "Wrong password.";
    }

} elseif (isset($_GET['passgen'])) {

    // We want to generate a salt and password
    $password   = $_GET['passgen'];
    $randSalt   = (string)rand();
    $generate   = crypt($password, $randSalt);
    $genPass    = md5($generate);

    $html = '<body style="width: 70%; margin: 20px auto; text-align: center; font-family: arial; line-height: 3em">';

    $html .= '<p><label>Add the following code to <code>'.$_SERVER['SCRIPT_FILENAME'].'</code><br /><textarea cols="50" rows="2" style="padding: 10px">';
    $html .= '$salt = \''.$randSalt.'\';'."\n";
    $html .= '$pass = \''.$genPass.'\';';
    $html .= '</textarea></label></p>';

    $callURL = 'http';
    if (isset($_SERVER['HTTPS']))   $callURL .= 's';
    $callURL .= '://'.$_SERVER['SERVER_NAME'].$_SERVER['SCRIPT_NAME'].'?update='.$_GET['passgen'];

    $html .= '<p><label>Add this URL your project\'s "Post-Recieve URLs"<br /><input type="text" value="'.$callURL.'" style="width: 500px; text-align: center;" /></label></p>';

    echo $html;

} elseif ( $email ) {
    mail($email, '['.$projectName.'] `git pull` failed', $msg, $headers);
}

Source : https://github.com/WolfieZero/github-auto-pull

Générer le mot de passe (hash)

Dans un navigateur, rendez-vous au fichier que vous venez de créer en ajoutant le paramètre `?passgen=PUBLIC_PASSWORD, où password représente le mot de passe voulu : http://YOUR_URL/github.php?passgen=PUBLIC_PASSWORD.

Remplacer les valeurs par défaut dans le fichier github.php

Utilisez les valeurs obtenues à l'étape précédente ($salt et $pass) pour remplacer les valeurs vides en haut du fichier github.php.

Configurer le webhook dans Github

Dans votre repository Github, configurer un webhook avec le URL suivant : http://xxx.com/github.php?update=PUBLIC_PASSWORD (en remplaçant PUBLIC_PASSWORD par celui utilisé plus haut)

Le tour est joué.