Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/stakater/GitWebhookProxy

A proxy to let webhooks reach running services behind a firewall – [✩Star] if you're using it!
https://github.com/stakater/GitWebhookProxy

firewall githook github gitlab gitops hacktoberfest jenkins jenkins-proxy k8s kubernetes openshift proxy webhook

Last synced: 11 days ago
JSON representation

A proxy to let webhooks reach running services behind a firewall – [✩Star] if you're using it!

Lists

README 

        
# ![](assets/web/gitwebhookproxy-round-100px.png)  GitWebhookProxy



[![Go Report Card](https://goreportcard.com/badge/github.com/stakater/GitWebhookProxy?style=flat-square)](https://goreportcard.com/report/github.com/stakater/GitWebhookProxy)

[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/stakater/GitWebhookProxy)

[![Release](https://img.shields.io/github/release/stakater/GitWebhookProxy.svg?style=flat-square)](https://github.com/stakater/GitWebhookProxy/releases/latest)

[![GitHub tag](https://img.shields.io/github/tag/stakater/GitWebhookProxy.svg?style=flat-square)](https://github.com/stakater/GitWebhookProxy/releases/latest)

[![Docker Pulls](https://img.shields.io/docker/pulls/stakater/gitwebhookproxy.svg?style=flat-square)](https://hub.docker.com/r/stakater/GitWebhookProxy/)

[![Docker Stars](https://img.shields.io/docker/stars/stakater/gitwebhookproxy.svg?style=flat-square)](https://hub.docker.com/r/stakater/GitWebhookProxy/)

[![MicroBadger Size](https://img.shields.io/microbadger/image-size/jumanjiman/puppet.svg?style=flat-square)](https://microbadger.com/images/stakater/GitWebhookProxy)

[![MicroBadger Layers](https://img.shields.io/microbadger/layers/_/httpd.svg?style=flat-square)](https://microbadger.com/images/stakater/GitWebhookProxy)

[![license](https://img.shields.io/github/license/stakater/GitWebhookProxy.svg?style=flat-square)](LICENSE)



A proxy to let webhooks to reach a Jenkins instance running behind a firewall



## PROBLEM



Jenkins is awesome and matchless tool for both CI & CD; but unfortunately its a gold mine if left in wild with wide open access; so, we always want to put it behind a firewall. But when we put it behind firewall then webhooks don't work anymore and no one wants the pull based polling but rather prefer the build to start as soon as there is a commit!



## SOLUTION



This little proxy makes webhooks start working again!



### Supported Providers



Currently we support the following git providers out of the box:



* Github

* Gitlab



### Configuration



GitWebhookProxy can be configured by providing the following arguments either via command line or via environment variables:



| Parameter     | Description                                                                       | Default  | Example                                    |

|---------------|-----------------------------------------------------------------------------------|----------|--------------------------------------------|

| listenAddress | Address on which the proxy listens.                                               | `:8080`  | `127.0.0.1:80`                             |

| upstreamURL   | URL to which the proxy requests will be forwarded (required)                      |          | `https://someci-instance-url.com/webhook/` |

| secret        | Secret of the Webhook API. If not set validation is not made.                     |          | `iamasecret`                               |

| provider      | Git Provider which generates the Webhook                                          | `github` | `github` or `gitlab`                       |

| allowedPaths  | Comma-Separated String List of allowed paths on the proxy                         |          | `/project` or `github-webhook/,project/`   |

| ignoredUsers  | Comma-Separated String List of users to ignore while proxying Webhook request     |          | `someuser`                                 |

| allowedUsers  | Comma-Separated String List of users to allow while proxying Webhook request      |          | `someuser`                                 |



## DEPLOYING TO KUBERNETES



The GitWebhookProxy can be deployed with vanilla manifests or Helm Charts.



### Vanilla Manifests



For Vanilla manifests, you can either first clone the respository or download the `deployments/kubernetes/gitwebhookproxy.yaml` file only.



#### Configuring



Below mentioned attributes in `gitwebhookproxy.yaml` have been hard coded to run in our cluster. Please make sure to update values of these according to your own configuration.



1. Change below mentioned attribute's values in `Ingress` in `gitwebhookproxy.yaml`



```yaml

 rules:

  - host: gitwebhookproxy.example.com

```



```yaml

  tls:

  - hosts:

    - gitwebhookproxy.example.com

```



2. Change below mentioned attribute's values in `Secret` in `gitwebhookproxy.yaml`



```yaml

data:

  secret: example

```



3. Change below mentioned attribute's values in `ConfigMap` in `gitwebhookproxy.yaml`



```yaml

data:

  provider: github

  upstreamURL: https://jenkins.example.com

  allowedPaths: /github-webhook,/project

  ignoredUsers: stakater-user

```



#### Deploying



Then you can deploy GitwebhookProxy by running the following kubectl commands:



```bash

kubectl apply -f gitwebhookproxy.yaml -n 

```



*Note:* Make sure to update the `port` in deployment.yaml as well as service.yaml if you change the default `listenAddress` port.



### Helm Charts



Alternatively if you have configured helm on your cluster, you can add gitwebhookproxy to helm from our public chart repository and deploy it via helm using below mentioned commands



1. Add the chart repo:



   i. `helm repo add stakater https://stakater.github.io/stakater-charts/`



   ii. `helm repo update`

2. Set configuration as discussed in the `Configuring` section



   i. `helm fetch --untar stakater/gitwebhookproxy`



   ii. Open and edit `gitwebhookproxy/values.yaml` in a text editor and update the values mentioned in `Configuring` section.



3. Install the chart

   * `helm install stakater/gitwebhookproxy -f gitwebhookproxy/values.yaml -n gitwebhookproxy`



## Running outside Kubernetes



### Run with Docker



To run the docker container outside of Kubernetes, you can pass the configuration as the Container Entrypoint arguments.

The docker image is available on docker hub. Example below:



`docker run stakater/gitwebhookproxy:v0.2.63 -listen :8080 -upstreamURL google.com -provider github -secret "test"`



### Run with Docker compose



For docker compose, the syntax is a bit different



```yaml

jenkinswebhookproxy: 

    image: 'stakater/gitwebhookproxy:latest'

    command: ["-listen", ":8080", "-secret", "test", "-upstreamURL", "jenkins.example.com, "-allowedPaths", "/github-webhook,/ghprbhook"]

    restart: on-failure

```



## Troubleshooting

### 405 Method Not Allowed with Jenkins & github plugin

If you get the following error when setting up webhooks for your jobs in Jenkins, make sure you have the trailing `/` in the webhook configured in Jenkins. 

```

Error Redirecting '/github-webhook' to upstream', Upstream Redirect Status: 405 Method Not Allowed

```



## Help



**Got a question?**

File a GitHub [issue](https://github.com/stakater/GitWebhookProxy/issues), or send us an [email](mailto:[email protected]).



### Talk to us on Slack

Join and talk to us on the #tools-gwp channel for discussing about GitWebhookProxy



[![Join Slack](https://stakater.github.io/README/stakater-join-slack-btn.png)](https://slack.stakater.com/)

[![Chat](https://stakater.github.io/README/stakater-chat-btn.png)](https://stakater-community.slack.com/messages/CAQ5A4HGD)



## Contributing



### Bug Reports & Feature Requests



Please use the [issue tracker](https://github.com/stakater/GitWebhookProxy/issues) to report any bugs or file feature requests.



### Developing



PRs are welcome. In general, we follow the "fork-and-pull" Git workflow.



 1. **Fork** the repo on GitHub

 2. **Clone** the project to your own machine

 3. **Commit** changes to your own branch

 4. **Push** your work back up to your fork

 5. Submit a **Pull request** so that we can review your changes



NOTE: Be sure to merge the latest from "upstream" before making a pull request!



## Changelog



View our closed [Pull Requests](https://github.com/stakater/GitWebhookProxy/pulls?q=is%3Apr+is%3Aclosed).



## License



Apache2 © [Stakater](http://stakater.com)



## About



`GitWebhookProxy` is maintained by [Stakater][website]. Like it? Please let us know at 



See [our other projects][community]

or contact us in case of professional services and queries on 



  [website]: http://stakater.com/

  [community]: https://github.com/stakater/