Download Chappy - Download do código -fonte Chappy

Chappy

Outro código-fonte

1.0.0

Baixar

Chappy

Chappy é a maneira mais simples de implantar sites usando o Github Webhooks.

Definir um projeto e um script de implantação para executar e o Chappy ouvirá alterações no seu repositório do GitHub e implantará automaticamente. É perfeito para implantações em pequena escala, como um único servidor digital.

Guia de início rápido

Download

Sistema operacional
Linux x64
Maxos (10,7 e acima)
Windows x64
Windows x32

Existem mais opções para diferentes tipos de sistema operacional na pasta build .

Instalação

Para começar, faça o download do executável correto para o seu sistema operacional e mova -o para um diretório no seu $PATH . Por exemplo, no Linux X64:

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

❓ Perguntas? Você pode ler as instruções de instalação passo a passo para Linux, Mac e Windows.

Criando um projeto

O próximo passo é criar um arquivo de projetos que definirá os webhooks que você deseja servir para um ou mais repositórios. Primeiro, crie um arquivo projects.json vazio no diretório Home ou WWW. Vamos definir um projeto chamado MyWebsite que executará um script de implantação localizado em /var/www/MyWebsite/deploy.sh .

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

? Para garantir que apenas o Github possa executar seu webhook, cada projeto deve ter uma string secreta única. Você pode gerar rapidamente uma string aleatória de 32 caracteres executando chappy secret ou usar um gerador de senha aleatória - de qualquer maneira, substitua <SECRET> .

Criando um script de implantação

Seu script de implantação deve ser um script executável (certifique -se de chmod +x deploy.sh ). Na forma mais básica, ele deve executar git pull , para atualizar o repositório com as últimas alterações. O exemplo abaixo instala quaisquer novas dependências com o Composer e NPM e reconstrói os ativos usando Gulp.

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

Os argumentos com os detalhes do evento são passados para o script, que podem ser usados para executar comandos dinamicamente. Existem alguns exemplos de script de implantação mais avançados na página de script de implantação que mostram como usar esse recurso.

Agora você pode começar a capiar usando

$ chappy start

⚙ Verifique a página da CLI para ver uma lista de comandos disponíveis, como configurar o IP e a porta em que o Chappy é executado e permitir outras configurações, como recarregar o arquivo de projetos ou servir sobre HTTPS.

Criando o webhook

Adicione um novo webhook ao seu repo Github, que pode ser encontrado em Configurações -> Webhooks -> Adicionar webhook.

Por padrão, o URL da carga útil será o seu servidor IP, a porta 9000 e depois o nome do seu projeto. ou seja, http://123.456.0.1:9000/MyWebsite .
Um tipo de conteúdo de application/json é recomendado, mas pode ser qualquer.
O segredo deve ser a sequência secreta que você definiu no projects.json .
O evento que você precisa ouvir é apenas o evento push .

Teste

⏰ Em breve - o Chappy registrará um arquivo, informando se está errado - e ouça o evento Github ping para pular a necessidade de fazer uma confirmação de teste.

Para testar tudo funcionar com sucesso, faça uma solicitação de compromisso de teste ou puxe para a ramificação principal ( "Beep, Boop! - Testing Chappy ?" Será bom).

Se o webhook terminar sem erros e seu script funcionar corretamente, parabéns?! Se houver erros, leia a página Solução de problemas ou envie um problema. ?