From 6d7ac15a89bf048340e7369e6ee06f330a2f454a Mon Sep 17 00:00:00 2001
From: pdoroff <phil21@phil21.net>
Date: Wed, 22 Feb 2017 23:09:38 -0600
Subject: [PATCH] added weechat documentation to README.pm

---
 deploy/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/deploy/README.md b/deploy/README.md
index d8c2f57c..eafa1d62 100644
--- a/deploy/README.md
+++ b/deploy/README.md
@@ -77,3 +77,25 @@ acme.sh --deploy -d ftp.example.com --deploy-hook exim4
 ```sh
 acme.sh --deploy -d ftp.example.com --deploy-hook keychain
 ```
+## 7. Deploy the cert to local weechat IRC client through fifo plugin
+
+Before you can deploy your cert, you must [issue the cert first](https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert).
+
+Then you can deploy now:
+
+```sh
+export DEPLOY_WEECHAT_PEM=~/.weechat/ssl/relay.pem
+export DEPLOY_WEECHAT_HOME=~/.weechat
+acme.sh --deploy -d weechat.example.com --deploy --deploy-hook weechat
+
+Notes:
+* Run acme.sh under the same user as the weechat client
+* Weechat must be configured with ```plugins.var.fifo.fifo = on```
+
+On deploy, the weechat deploy hook copies the the relevant data to $DEPLOY_WEECHAT_PEM.
+Additionally, this hook attempts to issue a ```/relay sslcertkey``` command via the FIFO
+plugin.  The FIFO files are searched for within $DEPLOY_WEECHAT_HOME.  Both environment
+variables default to weechat's defaults listed above.
+
+If successful, this installs and reloads the new relay SSL certificate in the
+client requiring no user interaction whatsoever.