From de494d4cc6002e49f2b37cf2b9753cf9451aa1bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Hajdarevi=C4=87?= Date: Sat, 4 Nov 2017 21:00:33 +0100 Subject: [PATCH 1/6] Add guides featuring webhook --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a41ffe6..09a979f 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,10 @@ You can use [almir/webhook](https://hub.docker.com/r/almir/webhook/) docker imag # Examples Check out [Hook examples page](https://github.com/adnanh/webhook/wiki/Hook-Examples) for more complex examples of hooks. +## Guides featuring webhook + - [Webhook & JIRA](https://sites.google.com/site/mrxpalmeiras/notes/jira-webhooks) by @perfecto25 + - [Trigger Ansible AWX job runs on SCM (e.g. git) commit](http://jpmens.net/2017/10/23/trigger-awx-job-runs-on-scm-commit/) by [@jpmens](http://mens.de/) + # Contributing Any form of contribution is welcome and highly appreciated. From c094740905f60b4479299c95fd290e81e9a0d69a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Hajdarevi=C4=87?= Date: Sat, 4 Nov 2017 21:52:26 +0100 Subject: [PATCH 2/6] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 09a979f..f3fba2a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,13 @@ If you don't have time to waste configuring, hosting, debugging and maintaining your webhook instance, we offer a __SaaS__ solution that has all of the capabilities webhook provides, plus a lot more, and all that packaged in a nice friendly web interface. If you are interested, find out more at [hookdoo website](https://www.hookdoo.com/?ref=github-webhook-readme). If you have any questions, you can contact us at info@hookdoo.com # Ensure active development +## Ad Clicks +You can show support by clicking the codesponsor.io ad below + + Sponsor + + +## Money [![Backers on Open Collective](https://opencollective.com/webhook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/webhook/sponsors/badge.svg)](#sponsors) [![Flattr this](https://button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) @@ -110,10 +117,6 @@ See the [webhook-contrib][wc] repository for a collections of tools and helpers ## BrowserStack [BrowserStack](https://www.browserstack.com/?ref=webhook) is a cloud-based cross-browser testing tool that enables developers to test their websites across various browsers on different operating systems and mobile devices, without requiring users to install virtual machines, devices or emulators. - - Sponsor - - ## Contributors This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). From 1e67afc3de75350ae70cd3aff23c3b9e303b90e8 Mon Sep 17 00:00:00 2001 From: Eric Berry Date: Sun, 5 Nov 2017 06:14:08 -0800 Subject: [PATCH 3/6] Remove Code Sponsor --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index f3fba2a..dfe578b 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,6 @@ If you don't have time to waste configuring, hosting, debugging and maintaining your webhook instance, we offer a __SaaS__ solution that has all of the capabilities webhook provides, plus a lot more, and all that packaged in a nice friendly web interface. If you are interested, find out more at [hookdoo website](https://www.hookdoo.com/?ref=github-webhook-readme). If you have any questions, you can contact us at info@hookdoo.com -# Ensure active development -## Ad Clicks -You can show support by clicking the codesponsor.io ad below - - Sponsor - - ## Money [![Backers on Open Collective](https://opencollective.com/webhook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/webhook/sponsors/badge.svg)](#sponsors) From 2f7eb31e8d8271aa4090c520475a7bc8dca2777b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Hajdarevi=C4=87?= Date: Sun, 5 Nov 2017 16:09:31 +0100 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dfe578b..a55f9aa 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ If you don't have time to waste configuring, hosting, debugging and maintaining your webhook instance, we offer a __SaaS__ solution that has all of the capabilities webhook provides, plus a lot more, and all that packaged in a nice friendly web interface. If you are interested, find out more at [hookdoo website](https://www.hookdoo.com/?ref=github-webhook-readme). If you have any questions, you can contact us at info@hookdoo.com -## Money +## Support [![Backers on Open Collective](https://opencollective.com/webhook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/webhook/sponsors/badge.svg)](#sponsors) [![Flattr this](https://button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) From 2adf7242955dfcd449ac276b5714650e9d581562 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Hajdarevi=C4=87?= Date: Sun, 5 Nov 2017 16:23:10 +0100 Subject: [PATCH 5/6] Update README.md --- README.md | 50 +++++++++++++++++++++++--------------------------- 1 file changed, 23 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index a55f9aa..36e8c39 100644 --- a/README.md +++ b/README.md @@ -5,17 +5,6 @@ If you don't have time to waste configuring, hosting, debugging and maintaining your webhook instance, we offer a __SaaS__ solution that has all of the capabilities webhook provides, plus a lot more, and all that packaged in a nice friendly web interface. If you are interested, find out more at [hookdoo website](https://www.hookdoo.com/?ref=github-webhook-readme). If you have any questions, you can contact us at info@hookdoo.com -## Support -[![Backers on Open Collective](https://opencollective.com/webhook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/webhook/sponsors/badge.svg)](#sponsors) - -[![Flattr this](https://button.flattr.com/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) - -[Donate via PayPal](https://paypal.me/hookdoo) - -[Patreon page](https://www.patreon.com/webhook) - -[![Faircode](https://faircode.io/product/webhook/badge)](https://faircode.io/product/webhook?utm_source=badge&utm_medium=badgelarge&utm_campaign=webhook) - # What is webhook? [webhook](https://github.com/adnanh/webhook/) is a lightweight configurable tool written in Go, that allows you to easily create HTTP endpoints (hooks) on your server, which you can use to execute configured commands. You can also pass data from the HTTP request (such as headers, payload or query variables) to your commands. [webhook](https://github.com/adnanh/webhook/) also allows you to specify rules which have to be satisfied in order for the hook to be triggered. @@ -106,26 +95,15 @@ Big thanks to [all the current contributors](https://github.com/adnanh/webhook/g # Community Contributions See the [webhook-contrib][wc] repository for a collections of tools and helpers related to [webhook][w] that have been contributed by the [webhook][w] community. -# Sponsors +# Support active development + +## Sponsors ## BrowserStack [BrowserStack](https://www.browserstack.com/?ref=webhook) is a cloud-based cross-browser testing tool that enables developers to test their websites across various browsers on different operating systems and mobile devices, without requiring users to install virtual machines, devices or emulators. -## Contributors +--- -This project exists thanks to all the people who contribute. [[Contribute]](CONTRIBUTING.md). - - - -## Backers - -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/webhook#backer)] - - - - -## Sponsors - -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/webhook#sponsor)] +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. @@ -138,7 +116,25 @@ Support this project by becoming a sponsor. Your logo will show up here with a l +## By contributing +This project exists thanks to all the people who contribute. [Contribute](CONTRIBUTING.md). + + +## By giving money + +Thank you to all our backers! + + + +--- + + - [OpenCollective Backer](https://opencollective.com/webhook#backer) + - [OpenCollective Sponsor](https://opencollective.com/webhook#sponsor) + - [Flattr](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) + - [PayPal](https://paypal.me/hookdoo) + - [Patreon](https://www.patreon.com/webhook) + - [Faircode](https://faircode.io/product/webhook?utm_source=badge&utm_medium=badgelarge&utm_campaign=webhook) # License From 7a91168f2366654ae581ef1d51cb99792aa628a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Hajdarevi=C4=87?= Date: Sun, 5 Nov 2017 16:49:36 +0100 Subject: [PATCH 6/6] Update README.md --- README.md | 40 +++++++++++++++++----------------------- 1 file changed, 17 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 36e8c39..9d12f75 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -[![ghit.me](https://ghit.me/badge.svg?repo=adnanh/webhook)](https://ghit.me/repo/adnanh/webhook) [![Join the chat at https://gitter.im/adnanh/webhook](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/adnanh/webhook?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - # Hookdoo hookdoo @@ -21,8 +19,6 @@ If you use Mattermost or Slack, you can set up an "Outgoing webhook integration" Everything else is the responsibility of the command's author. ---- - # Getting started ## Installation ### Building from source @@ -71,30 +67,28 @@ By performing a simple HTTP GET or POST request to that endpoint, your specified However, hook defined like that could pose a security threat to your system, because anyone who knows your endpoint, can send a request and execute your command. To prevent that, you can use the `"trigger-rule"` property for your hook, to specify the exact circumstances under which the hook would be triggered. For example, you can use them to add a secret that you must supply as a parameter in order to successfully trigger the hook. Please check out the [Hook rules page](https://github.com/adnanh/webhook/wiki/Hook-Rules) for detailed list of available rules and their usage. -# Using HTTPS +## Using HTTPS [webhook](https://github.com/adnanh/webhook/) by default serves hooks using http. If you want [webhook](https://github.com/adnanh/webhook/) to serve secure content using https, you can use the `-secure` flag while starting [webhook](https://github.com/adnanh/webhook/). Files containing a certificate and matching private key for the server must be provided using the `-cert /path/to/cert.pem` and `-key /path/to/key.pem` flags. If the certificate is signed by a certificate authority, the cert file should be the concatenation of the server's certificate followed by the CA's certificate. -# CORS Headers +## CORS Headers If you want to set CORS headers, you can use the `-header name=value` flag while starting [webhook](https://github.com/adnanh/webhook/) to set the appropriate CORS headers that will be returned with each response. -# Interested in running webhook inside of a Docker container? +## Interested in running webhook inside of a Docker container? You can use [almir/webhook](https://hub.docker.com/r/almir/webhook/) docker image, or create your own (please read [this discussion](https://github.com/adnanh/webhook/issues/63)). -# Examples +## Examples Check out [Hook examples page](https://github.com/adnanh/webhook/wiki/Hook-Examples) for more complex examples of hooks. -## Guides featuring webhook +### Guides featuring webhook - [Webhook & JIRA](https://sites.google.com/site/mrxpalmeiras/notes/jira-webhooks) by @perfecto25 - [Trigger Ansible AWX job runs on SCM (e.g. git) commit](http://jpmens.net/2017/10/23/trigger-awx-job-runs-on-scm-commit/) by [@jpmens](http://mens.de/) -# Contributing -Any form of contribution is welcome and highly appreciated. - -Big thanks to [all the current contributors](https://github.com/adnanh/webhook/graphs/contributors) for their contributions! - -# Community Contributions +## Community Contributions See the [webhook-contrib][wc] repository for a collections of tools and helpers related to [webhook][w] that have been contributed by the [webhook][w] community. +## Need help? +Check out [existing issues](https://github.com/adnanh/webhook/issues) to see if someone else also had the same problem, or [open a new one](https://github.com/adnanh/webhook/issues/new). + # Support active development ## Sponsors @@ -118,24 +112,24 @@ Support this project by becoming a sponsor. Your logo will show up here with a l ## By contributing -This project exists thanks to all the people who contribute. [Contribute](CONTRIBUTING.md). +This project exists thanks to all the people who contribute. [Contribute!](CONTRIBUTING.md). ## By giving money -Thank you to all our backers! - - - ---- - - [OpenCollective Backer](https://opencollective.com/webhook#backer) - [OpenCollective Sponsor](https://opencollective.com/webhook#sponsor) - - [Flattr](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) - [PayPal](https://paypal.me/hookdoo) - [Patreon](https://www.patreon.com/webhook) - [Faircode](https://faircode.io/product/webhook?utm_source=badge&utm_medium=badgelarge&utm_campaign=webhook) + - [Flattr](https://flattr.com/submit/auto?user_id=adnanh&url=https%3A%2F%2Fwww.github.com%2Fadnanh%2Fwebhook) +--- + +Thank you to all our backers! + + + # License The MIT License (MIT)