webhook-api/README.md
2016-01-30 21:53:35 +01:00

46 lines
895 B
Markdown

Webhook API
===========
Gogs webhook api system writed for [gitnet] project.
Installation
------------
### Requirements
* PHP >= 5.4
### With GIT
$ git clone https://gitnet.fr/deblan/webhook-api.git
### Without GIT
$ wget https://gitnet.fr/deblan/webhook-api/archive/master.tar.gz
$ tar xvf master.tar.gz
### Access keys
$ cp accounts.php-dist accounts.php
$ ... Add API keys in accounts.php ...
[gitnet]: https://gitnet.fr/project/gitnet
Webhook configuration
---------------------
### Payloading url
Configure a http webserver with PHP to access `event.php` script.
*https://webhook.deblan.org/event.php* for [gitnet].
### Content Type
Set `application/x-www-form-urlencoded`.
### Secret
Choose an access key from `accounts.php`.
If you use [gitnet], the [administrator](https://gitnet.fr/deblan) sent you the secret key by email.
[gitnet]: https://gitnet.fr/project/gitnet