Chappy Download - Chappy Source Code Download

Chappy

Anderer Quellcode

1.0.0

Herunterladen

Chappy

Chappy ist der einfachste Weg, um Websites mithilfe von Github -Webhooks bereitzustellen.

Definieren Sie ein Projekt- und Bereitstellungsskript zum Ausführen, und Chappy wird nach Änderungen an Ihrem Github -Repo und automatisch eingesetzt. Es eignet sich perfekt für kleine Bereitstellungen wie einen einzelnen digitaloceanischen Server ❄️

Schnellstarthandbuch

Herunterladen

Betriebssystem
Linux x64
Maxos (10,7 und höher)
Windows x64
Windows x32

Es gibt mehr Optionen für verschiedene Arten von Betriebssystemen im build -Ordner.

Installation

Laden Sie, um zu beginnen, die richtige ausführbare Datei für Ihr Betriebssystem herunter und verschieben Sie es in ein Verzeichnis in Ihrem $PATH . Zum Beispiel unter Linux x64:

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

❓ Fragen? Sie können die Schritt -für -Schritt -Installationsanweisungen für Linux, Mac und Windows lesen.

Ein Projekt erstellen

Der nächste Schritt besteht darin, eine Projektdatei zu erstellen, die die Webhooks definiert, die Sie für eine oder mehrere Repos dienen möchten. Erstellen Sie zunächst eine leere projects.json -Datei in Ihrem Zuhause oder in WWW -Verzeichnis. Definieren wir ein Projekt namens MyWebsite , das ein Bereitstellungsskript in /var/www/MyWebsite/deploy.sh ausführt.

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

? Um sicherzustellen, dass nur GitHub Ihr Webhook ausführen kann, sollte jedes Projekt eine einzigartige geheime Zeichenfolge haben. Sie können schnell eine zufällige 32 -Zeichen -Zeichenfolge erstellen, indem Sie chappy secret ausführen oder einen zufälligen Kennwortgenerator verwenden - in beiden Fällen stellen Sie sicher, dass Sie <SECRET> ersetzen.

Erstellen eines Bereitstellungsskripts

Ihr Bereitstellungsskript sollte ein ausführbares Skript sein (stellen Sie sicher, dass chmod +x deploy.sh ). In seiner grundlegendsten Form sollte es git pull ausführen, um das Repo mit den neuesten Änderungen zu aktualisieren. Das folgende Beispiel installiert neue Abhängigkeiten mit Komponisten und NPM und baut mit Gulp um.

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

Argumente mit den Ereignisdetails werden an das Skript übergeben, mit dem Befehle dynamisch ausgeführt werden können. Auf der Seite "Skript Bereitstellen" gibt es einige erweiterte Bereitstellungs -Skript -Beispiele, auf denen die Verwendung dieser Funktion angezeigt wird.

Sie können jetzt mithilfe von Chappy beginnen

$ chappy start

⚙ Überprüfen Sie die CLI -Seite, um eine Liste der verfügbaren Befehle anzuzeigen, wie Sie die IP und den Port konfigurieren, auf dem Chappy ausgeführt wird, und aktivieren Sie andere Einstellungen wie Hot, die die Projektdatei neu laden oder HTTPS dienen.

Erstellen des Webhooks

Fügen Sie Ihrem Github Repo einen neuen Webhook hinzu, der in Einstellungen -> Webhooks -> Webhook hinzugefügt werden kann.

Standardmäßig ist die Nutzlast -URL Ihr Server -IP, Port 9000 und dann Ihr Projektname. IE http://123.456.0.1:9000/MyWebsite .
Es wird ein Inhaltstyp der application/json empfohlen, kann jedoch alle sein.
Das Geheimnis sollte die geheime Zeichenfolge sein, die Sie in projects.json definiert haben.
Das Ereignis, das Sie hören müssen, ist nur das push -Event.

Testen

⏰ Bald kommen - Chappy wird sich in einer Datei anmelden, in der Sie wissen, ob etwas falsch ist - und auf das Github ping -Ereignis zuhören, um zu überspringen, um ein Testkomit zu erhalten.

Um alles erfolgreich zu testen, machen Sie einen Testkomitee oder ziehen Sie die Anfrage an die Hauptzweig ( "Beep, Boop! - Testing Chappy ?" Wird es gut abschneiden).

Wenn das Webhook ohne Fehler endet und Ihr Skript korrekt ausgeführt wird, herzlichen Glückwunsch?! Wenn Fehler vorliegen, lesen Sie bitte die Seite Fehlerbehebung oder senden Sie ein Problem. ?