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)