This is a simple Github web hook server which streams incoming events into a Kafka queue. Each incoming web hook event will be validated with the Github secret and any incoming requests not matching the validation will be rejected with a HTTP status code 401 Unauthorized.
The following environment variables need to be set:
GWK_GITHUB_SECRET- this is the secret used when creating / registering the web hook. Defaults to empty stringGWK_KAFKA_BROKERS- a comma separated list of Kafka servers. Defaults tolocalhost:9092GWK_PORT- webserver HTTP port. defaults to8000
Optionally, you can control debugging with:
GWK_KAFKA_TOPIC_PREFIX- the kafka topic prefix which is append to the Github event name. defaults togithub/unprocessed/GWK_PAYLOAD_DEBUG- dump each incoming JSON event payload to the console whentrueGWK_KAFKA_DEBUG- log kafka details whentrue
You can easily run using Docker.
If you want to use a pre-built container (jhaynie/github-webhook-kafka), you could use something like:
docker run -d -p 8000:8000 -e GWK_GITHUB_SECRET=hello -e GWK_KAFKA_BROKERS=192.168.1.1:9092 jhaynie/github-webhook-kafka
Make sure you use the correct GWK_GITHUB_SECRET and GWK_KAFKA_BROKERS values. This will run the container on port 8000 by default.
For development, you can use the all-in-one container which contains Kafka, Zookeeper and this software:
docker run -d -p 8000:8000 -p 2181:2181 -p 9092:9092 -e GWK_GITHUB_SECRET=hello -e GWK_ADVERTISED_HOST=192.168.1.1 jhaynie/github-webhook-kafka-dev
Make sure you use the correct GWK_GITHUB_SECRET, GWK_ADVERTISED_HOST values.
Copyright (c) 2016 by Jeff Haynie
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.