From 96dcd2423198e1f3ef56779b2d6cbb98925ca27b Mon Sep 17 00:00:00 2001
From: Ben Harris <ben@tilde.team>
Date: Thu, 27 Jun 2019 09:37:15 -0400
Subject: [PATCH] add weechat unix relay docs

---
 wiki/pages/irc.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/wiki/pages/irc.md b/wiki/pages/irc.md
index c1d3092..a47675f 100644
--- a/wiki/pages/irc.md
+++ b/wiki/pages/irc.md
@@ -27,4 +27,39 @@ this is the beginning of the [tilde.chat](https://tilde.chat) irc federation! mo
 
 local connections (weechat, irssi, znc) can use 6667 without ssl
 
+## weechat relays
+
+weechat introduced [unix socket relays](
+https://weechat.org/files/doc/stable/weechat_user.en.html#relay_unix_socket)
+in version 2.5 which is a much easier way to offer per-user relay access.
+
+<user>.ttm.sh/weechat is configured to proxy to the default unix relay socket
+location (`~/.weechat/relay_socket`). to get started using it, follow these steps.
+
+in weechat:
+* `/relay add unix.weechat %h/relay_socket`
+* `/set relay.network.password mysupersecretpassword` - don't use this password
+    of course. note that you might already have this set.
+
+at your shell:
+* `chmod o+rw ~/.weechat/relay_socket` - note that other members of the team group
+    are not included in the granted permissions. this allows nginx to connect
+    to your socket on your behalf
+
+in your relay client:
+* glowing-bear:
+    - <user>.ttm.sh
+    - port 443
+    - your relay password
+
+* weechat-android:
+    - connection type: websocket (ssl)
+    - websocket path: weechat
+    - relay host: <user>.ttm.sh
+    - relay port: 443
+    - your relay password
+
+---
+
 for more info, see the [tilde.chat wiki](https://tilde.chat/wiki/) for info on bots and other specifics.
+