Descarga de Chappy - Descarga del código fuente Chappy

Chappy

Otro código fuente

1.0.0

Descargar

Tío

Chappy es la forma más sencilla de implementar sitios web utilizando GitHub Webhooks.

Defina un proyecto de proyecto e implementación para que se ejecute y Chappy escuchará los cambios en su repositorio de GitHub e implementará automáticamente. Es perfecto para implementaciones de pequeña escala como un solo servidor de DigitalOcean ❄️

Guía de inicio rápido

Descargar

Sistema operativo
Linux x64
Maxos (10.7 y más)
Windows x64
Windows x32

Hay más opciones para diferentes tipos de sistema operativo en la carpeta build .

Instalación

Para comenzar, descargue el ejecutable correcto para su sistema operativo y muévalo a un directorio en su $PATH . Por ejemplo en Linux x64:

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

❓ Preguntas? Puede leer las instrucciones de instalación paso a paso para Linux, Mac y Windows.

Creando un proyecto

El siguiente paso es crear un archivo de proyectos que definirá los webhooks que desea servir para uno o más repos. Primero, cree un archivo projects.json vacíos. Json en su hogar o directorio www. Definamos un proyecto llamado MyWebsite que ejecutará un script de implementación ubicado en /var/www/MyWebsite/deploy.sh .

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

? Para asegurarse de que solo GitHub pueda ejecutar su webhook, cada proyecto debe tener una cadena secreta única. Puede generar rápidamente una cadena aleatoria de 32 caracteres ejecutando chappy secret , o usar un generador de contraseña aleatorio, de cualquier manera, asegúrese de reemplazar <SECRET> .

Creación de un script de implementación

Su script de implementación debe ser un script ejecutable (asegúrese de chmod +x deploy.sh ). En su forma más básica, debe ejecutar git pull , para actualizar el repositorio con los últimos cambios. El siguiente ejemplo instala cualquier nueva dependencia con el compositor y NPM y reconstruye los activos utilizando GULP.

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

Los argumentos con los detalles del evento se pasan al script, que se puede usar para ejecutar comandos dinámicamente. Hay algunos ejemplos de script de implementación más avanzados en la página de script de implementación que muestran cómo usar esta función.

Ahora puedes comenzar a Chappy usando

$ chappy start

⚙ Verifique la página CLI para ver una lista de comandos disponibles, cómo configurar la IP y el puerto en el que Chappy se ejecuta y habilitar otras configuraciones como recargar el archivo de proyectos o servir a través de HTTPS.

Creando el webhook

Agregue un nuevo webhook a su repositorio de GitHub, que se puede encontrar en Configuración -> Webhooks -> Agregar webhook.

Por defecto, la URL de carga útil será su IP de servidor, puerto 9000 y luego el nombre de su proyecto. es decir, http://123.456.0.1:9000/MyWebsite .
Se recomienda un tipo de contenido de application/json pero puede ser cualquiera.
El secreto debe ser la cadena secreta que definió en projects.json .
El evento que necesita escuchar es solo el evento push .

Pruebas

⏰ Próximamente, Chappy registrará un archivo que le informará si algo está mal, y escuche el evento ping de GitHub para omitir tener que hacer una prueba de prueba.

Para probar todo se ejecuta con éxito, haga una solicitud de compromiso de prueba o retire a la rama principal ( "Beep, Boop! - Testing Chappy ?"

Si el webhook termina sin errores y su script se ejecuta correctamente, ¡felicidades? Si hay errores, lea la página de solución de problemas o envíe un problema. ?