Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

add rest_api.md and git_webhook.md help documents

Browse source
This commit is contained in:
jesopo 2019-09-13 16:02:56 +01:00
parent a77422f6f6
commit 7589262fbe
2 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/help/git_webhooks.md Normal file
View file

@ -0,0 +1,21 @@
## Configure git webhooks
First, follow instructions at [/docs/rest_api.md](/docs/rest_api.md)
### Generate API key
> /msg &lt;bot> apikey <comment> /api/github /api/gitea`
e.g.
> /msg &lt;bot> apikey github-jesopo /api/github /api/gitea`
### Enable hook in-channel
#### For single repository
> !webhook add <organisation>/<repository>
#### For whole organisation
> !webhook add <organisation>
### Format webhook URL
GitHub: `https://example.com:5000/api/github?key=<apikey>`
Gitea: `https://example.com:5000/api/gitea?key=<apikey>`

11
docs/help/rest_api.md Normal file
View file

@ -0,0 +1,11 @@
## Configure REST API
### Enable REST API
* `/msg <bot> config bot rest-api on`
* `/msg <bot> reloadmodule rest_api`
### Configure HTTPd
#### Nginx
* Copy example config file from [docs/rest_api/nginx](docs/rest_api/nginx) to `/etc/nginx/sites-enabled`
* Edit `server-name`, `ssl_certificate` and `ssl_certificate_key`
* `service nginx restart`