Go to file
konrad 91eaacc556 Added Binaries 2017-04-29 17:48:21 +02:00
bin Enabled Config 2017-04-28 21:19:58 +02:00
compiled-Release Added Binaries 2017-04-29 17:48:21 +02:00
pkg/linux_amd64 Enabled Config 2017-04-28 21:19:58 +02:00
src Added Binaries 2017-04-29 17:48:21 +02:00
.gitignore Updated Gitignore 2017-04-29 17:32:18 +02:00
Readme.md Updated Readme 2017-04-29 15:34:37 +02:00

Readme.md

Simple Git Deploy

This simple application provides automatic update of git repositories on your server. Triggered by a webhook (like the one from github), it can be very useful when you don't have (or don't want) a fully-fleged CI-Server to update your website.

Note: The application currently runs only under linux-systems as it uses a bash-script to update.

Usage

Usage is pretty simple. Simply configure the application via config.ini:

ssh_key=/path/to/deploy-key
git_url=ssh://git@your-server.tld/gitproject.git
deploy_dir=/path/to/deploy/dir
container_name=
secret= iamverySecret
interface=":8080" 
branch_name=refs/heads/master 
  • ssh_key: Path to the Deploy-SSH
  • git_url: SSH-Path to your Git-Project
  • deploy_dir: The folder to which the updated version of your site will be deployed. You need write permissions.
  • container_name: If you run your site within a docker-container, the application can automatically restart the container for any changes to take effect.
  • secret: The Secret sent by the webhook - to prevent abuse
  • interface: The interface the server should listen on
  • branch_name: The name of the branch. If an update to this branch is triggered, the application will run the update.

Troubleshooting

Not Cloning - the script runs pretty fast but wont clone

Check the permissions of your keyfile. They should be 600, otherwise the ssh-agent will ignore the keyfile and won't clone:

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@         WARNING: UNPROTECTED PRIVATE KEY FILE!          @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Permissions 0664 for '/path/to/deploy-key' are too open.
It is required that your private key files are NOT accessible by others.
This private key will be ignored.