Gitlab webhook runner README

Automated work with gitlab web hooks

How it work

• Configure this service:
  • Specify script path to handle web hooks
  • Set url to this service in gitlab
• Gitlab send web hooks to server
• This service listen commands and run script

Getting Started

• cd
• $VENV/bin/pip install -r requirements.txt
• $VENV/bin/pserve development.ini

How to config integration with gitlab

• Goto Integrations settings page: Settings / Integrations menu in project on gitlab
• Set secret token in gitlab
• Copy secret token to your ini file (gitlab_token = TOKEN)
• Set url for push events: http://example.com/gitlab/onpush
• Set url for merge events: http://example.com/gitlab/onmerge

How to read script execution log

Script output writes to console. It can be configured in ini file.

Docker

Access to the launch scripts from the container is realized via ssh transport. To do this, you need to configure the container to automate the launch of scripts via ssh. Your server must support access for ssh keys.

docker pull sank16/gitlab-webhook-runner

Configure and start the container

docker run -d -p 8888:6543 \
-e GITLABWEBHOOK_HOSTNAME="ssh-host-name" \
-e GITLABWEBHOOK_USERNAME=ssh-user-name \
-e GITLABWEBHOOK_SCRIPTPATH="/path/to/script/on/server" \
-e GITLABWEBHOOK_TOKEN="PUT-TOKEN-HERE" \
sank16/gitlab-webhook-runner

Goto config page to set ssh access to server
http://your-server:port/gitlab/docker_config

Set web hooks on your gitlab project (described in section above "How to config integration with gitlab")

Read script execution log:

docker logs -f CONTAINER_ID

Webhooks gitlab doc

https://gitlab.com/help/user/project/integrations/webhooks