konrad
/
Simple-Git-Deploy
mirror of https://github.com/kolaente/Simple-Git-Deploy.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Readme

This commit is contained in:
konrad 2017-04-29 15:31:22 +02:00 committed by konrad
parent 5bc2015ca8
commit 425b20c4b1
2 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Readme.md
View File

@ -10,15 +10,23 @@ Triggered by a webhook (like the one from github), it can be very useful when yo
Usage is pretty simple. Simply configure the application via config.ini:
```
ssh_key=/path/to/deploy-key # Path to the Deploy-SSH
git_url=ssh://git@your-server.tld/gitproject.git # SSH-Path to your Git-Project
deploy_dir=/path/to/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=":8080" # The interface the server should listen on
branch_name=refs/heads/master # The name of the branch. If an update to this branch is triggered, the application will run the update.
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

14
src/Simple-Git-Deploy/config.ini
View File

@ -1,7 +1,7 @@
ssh_key=/home/konrad/Schreibtisch/life-wob/life-deploy
git_url=ssh://git@git.mowie.cc:9022/Websites/Life-Homepage.git
deploy_dir=/home/konrad/Schreibtisch/life-wob/html
container_name=
secret=Baum
interface=":8080"
branch_name=refs/heads/master
ssh_key=/path/to/deploy-key # Path to the Deploy-SSH
git_url=ssh://git@your-server.tld/gitproject.git # SSH-Path to your Git-Project
deploy_dir=/path/to/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=":8080" # The interface the server should listen on
branch_name=refs/heads/master # The name of the branch. If an update to this branch is triggered, the application will run the update.