From 7589262fbe22ab412a5f46f704df393bdc4fc175 Mon Sep 17 00:00:00 2001
From: jesopo
Date: Fri, 13 Sep 2019 16:02:56 +0100
Subject: add rest_api.md and git_webhook.md help documents

---
 docs/help/git_webhooks.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 docs/help/git_webhooks.md

(limited to 'docs/help/git_webhooks.md')

diff --git a/docs/help/git_webhooks.md b/docs/help/git_webhooks.md
new file mode 100644
index 00000000..7d4e54dd
--- /dev/null
+++ b/docs/help/git_webhooks.md
@@ -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>`
-- 
cgit v1.3.1-10-gc9f91