diff options
Diffstat (limited to 'README.textile')
| -rw-r--r-- | README.textile | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/README.textile b/README.textile index 81fc536..400a4ae 100644 --- a/README.textile +++ b/README.textile @@ -2,28 +2,30 @@ h1. What is it? -this is a small HTTP server written in python. +this is a small HTTP server written in python. It allows you to have a version of your project installed, that will be updated automatically on each Github or Gitlab push. To set it up, do the following: * install python * copy the GitAutoDeploy.conf.json.example to GitAutoDeploy.conf.json. This file will be gitignored and can be environment specific. * enter the matching for your project(s) in the GitAutoDeploy.conf.json file -* start the server by typing "python GitAutoDeploy.py" +* start the server by typing "python GitAutoDeploy.py" * to run it as a daemon add ==--daemon-mode== -* On the Github or Gitlab page go to a repository, then "Admin", "Service Hooks", +* On the Github or Gitlab page go to a repository, then "Admin", "Service Hooks", "Post-Receive URLs" and add the url of your machine + port (e.g. http://example.com:8001). You can even test the whole thing here, by clicking on the "Test Hook" button, whohoo! h1. How this works -When someone pushes changes into Github or Gitlab, it sends a json file to the service hook url. +When someone pushes changes into Github or Gitlab, it sends a json file to the service hook url. It contains information about the repository that was updated. -All it really does is match the repository urls to your local repository paths in the config file, +All it really does is match the repository urls to your local repository paths in the config file, move there and run "git pull". -Additionally it runs a deploy bash command that you can add to the config file optionally. +Additionally it runs a deploy bash command that you can add to the config file optionally, and it also +allows you to add two global deploy commands, one that would run at the beginning and one that would run +at the end of the deploy. Make sure that you start the server as the user that is allowed to pull from the github or gitlab repository. |