diff --git a/notify.md b/notify.md index 7b05011..d047f92 100644 --- a/notify.md +++ b/notify.md @@ -152,8 +152,26 @@ acme.sh --set-notify --notify-hook slack The `SLACK_WEBHOOK_URL`, `SLACK_CHANNEL` and `SLACK_USERNAME` will be saved in ~/.acme.sh/account.conf and will be reused when needed. +## 5. Set notification for Slack App -## 5. Set notification for postmarkapp.com +Create [a Slack app](https://api.slack.com/apps) and allow the app to send messages by granting the `chat:write` permission. Once the app was allowed to send messages you need to install the app into your workspace. + +Slack channel and the App token can be configured via the following environement variables: + +```sh +export SLACK_APP_CHANNEL="..." +export SLACK_APP_TOKEN="xoxb-..." +``` + +Once the requried parameters have been configured you can setup the notification hook via the following command: + +``` +acme.sh --set-notify --notify-hook slack_app +``` + +The `SLACK_APP_CHANNEL` and `SLACK_APP_TOKEN` will be saved in ~/.acme.sh/account.conf and will be reused when needed. + +## 6. Set notification for postmarkapp.com Send notification by postmarkapp.com API. The notification email will be sent to your email address. First get your [token](https://account.postmarkapp.com), then set it in your systems environment: @@ -178,7 +196,7 @@ The `POSTMARK_TOKEN`, `POSTMARK_TO` and `POSTMARK_FROM` will be saved in ~/.acme If there are any bugs for postmarkapp.com API, please report here: https://github.com/Neilpang/acme.sh/issues/2309 -## 6. Set notification for pushover.net +## 7. Set notification for pushover.net Send notification via pushover.net's api. The notification will be pushed to the specified pushover application. @@ -212,7 +230,7 @@ The PUSHOVER_TOKEN, PUSHOVER_USER and PUSHOVER_SOUND will be saved in ~/.acme.sh If there are any bugs for pushover.net notify, please report here: https://github.com/Neilpang/acme.sh/issues/2329 -## 7. Set notification for IFTTT Webhooks +## 8. Set notification for IFTTT Webhooks Send notification via IFTTT Webhooks so that you can make acme.sh work with tons of [IFTTT](https://ifttt.com) services. @@ -244,7 +262,7 @@ The `IFTTT_API_KEY`, `IFTTT_EVENT_NAME`, `IFTTT_SUBJECT_KEY` and `IFTTT_CONTENT_ If there are any bugs for IFTTT Webhooks notify, please report here: https://github.com/Neilpang/acme.sh/issues/2421 -## 8. Set notification for xmpp (aka jabber) +## 9. Set notification for xmpp (aka jabber) Install `sendxmpp` manually or using your distributions package manager. Configure the sending account in `~/.sendxmpprc` e.g.: @@ -280,7 +298,7 @@ The `XMPP_TO`, `XMPP_BIN` and `XMPP_BIN_ARGS` will be saved in ~/.acme.sh/accoun On debian based systems `sendxmpp` has problems validating certificates (see https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=854210). -## 9. Set notification for dingtalk.com(钉钉) +## 10. Set notification for dingtalk.com(钉钉) Push notification to dingtalk group by group robot webhook api. First create a group robot, get your webhook url, and set a keyword. @@ -298,7 +316,7 @@ acme.sh --set-notify --notify-hook dingtalk ``` -## 10. Set notification for QQ with self-built CQHTTP API +## 11. Set notification for QQ with self-built CQHTTP API ### 中文说明 通过 CoolQ 的插件 CQHTTP 将消息推送到 QQ。需要您自行部署 CQHTTP 服务端。部署详情参见 [CoolQ 社区](https://cqp.cc)和 [CQHTTP](https://cqhttp.cc) 的文档。 @@ -597,4 +615,4 @@ message="$2" status="$3" do-something "$subject ($status): $message" -``` \ No newline at end of file +```