aboutsummaryrefslogtreecommitdiff
path: root/docs/help/rest_api.md
diff options
context:
space:
mode:
authorGravatar jesopo2019-09-13 16:02:56 +0100
committerGravatar jesopo2019-09-13 16:02:56 +0100
commit7589262fbe22ab412a5f46f704df393bdc4fc175 (patch)
tree8013d162a77f8abc8e1d9d00616e5c8033d5a513 /docs/help/rest_api.md
parentadd rest_api example nginx config (diff)
signature
add rest_api.md and git_webhook.md help documents
Diffstat (limited to 'docs/help/rest_api.md')
-rw-r--r--docs/help/rest_api.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/help/rest_api.md b/docs/help/rest_api.md
new file mode 100644
index 00000000..8aaff68d
--- /dev/null
+++ b/docs/help/rest_api.md
@@ -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`