Загрузка Chappy - Загрузка исходного кода Chappy

Chappy

Другой исходный код

1.0.0

Скачать

Chappy

Chappy - самый простой способ развертывания веб -сайтов с помощью GitHub Webhooks.

Определите скрипт проекта и развертывания для запуска, и Chappy прослушивает изменения в вашем репо github и автоматически развернут. Он идеально подходит для небольших развертываний, таких как один сервер DigitaloCean ❄

Quick Start Guide

Скачать

Операционная система
Linux x64
Максос (10,7 и выше)
Windows x64
Windows x32

В папке build есть больше вариантов для различных типов операционной системы.

Установка

Чтобы начать, загрузите правильный исполняемый файл для вашей операционной системы и переместите его в каталог в вашем $PATH . Например, на Linux x64:

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

❓ Вопросы? Вы можете прочитать пошаговые инструкции по установке для Linux, Mac и Windows.

Создание проекта

Следующим шагом является создание файла проектов, который будет определять веб -крючки, которые вы хотите обслуживать для одного или нескольких репо. Во -первых, создайте пустой файл projects.json . Давайте определим проект под названием MyWebsite , который запустит сценарий развертывания, расположенный в /var/www/MyWebsite/deploy.sh .

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

? Чтобы убедиться, что только GitHub может запустить ваш веб -крючок, каждый проект должен иметь уникальную секретную строку. Вы можете быстро сгенерировать случайную строку 32 символов, запустив chappy secret или использовать генератор случайного пароля - в любом случае, обязательно замените <SECRET> .

Создание сценария развертывания

Ваш сценарий развертывания должен быть исполняемым сценарием (обязательно выполните chmod +x deploy.sh ). В этом наиболее основной форме он должен запустить git pull , чтобы обновить репо с последними изменениями. Пример ниже устанавливает любые новые зависимости с композитором и NPM и восстанавливает активы с использованием Gulp.

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

Аргументы с деталями события передаются в сценарий, который можно использовать для динамического запуска команд. На странице скрипта развертывания есть несколько более продвинутых примеров сценариев развертывания, которые показывают, как использовать эту функцию.

Теперь вы можете начать chappy, используя

$ chappy start

⚙ Проверьте страницу CLI, чтобы просмотреть список доступных команд, как настроить IP и порт, на котором работает Chappy, и включает другие настройки, такие как Hot Reloading файл проектов или обслуживание HTTPS.

Создание веб -крюка

Добавьте новый WebHook в свой репо github, который можно найти в настройках -> Webhooks -> Добавить Webhook.

По умолчанию URL -адрес полезной нагрузки будет IP -адресом вашего сервера, портом 9000, а затем именем вашего проекта. т.е. http://123.456.0.1:9000/MyWebsite .
Рекомендуется тип контента application/json но он может быть любой.
Секрет должен быть секретной строкой, которую вы определили в projects.json .
Событие, которое вам нужно выслушать, - это только push Event.

Тестирование

⏰ Скоро - Chappy войдет в файл, позволяющий вам знать, если что -то не так - и послушайте событие GitHub ping , чтобы пропустить необходимость сделать тестовый коммит.

Чтобы проверить все, что работает успешно, сделайте тестовый коммит или запрос на подключение к основной ветви ( "Beep, Boop! - Testing Chappy ?"

Если веб -крюк заканчивается без ошибок, а ваш скрипт работает правильно, тогда поздравляю?! Если есть ошибки, пожалуйста, прочитайте страницу устранения неполадок или отправьте проблему. ?