diff --git a/wiki/source/irc.md b/wiki/source/irc.md index 45db8e0..6b5e56d 100644 --- a/wiki/source/irc.md +++ b/wiki/source/irc.md @@ -33,6 +33,43 @@ after this, every time you reconnect to irc you will have to identify with nicks weechat tip: NickServ replies and error messages appear in the first buffer `tilde weechat` (use Alt + up/down to switch). +## 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. + +tilde.club/~username/weechat is configured to proxy to the default unix relay socket +location (`~/.weechat/relay_socket`). to get started using it, follow these steps. + +1. 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. + +2. at your shell: + * `chmod o+rw ~/.weechat/relay_socket` - note that other members of the club group + are not included in the granted permissions. this allows nginx to connect + to your socket on your behalf. you will need to do this every time you start + weechat as the socket doesn't exist until weechat starts up. + +3. in your relay client: + * glowing-bear: + - relay hostname: tilde.club:443/~username/weechat + - relay port: 443 + - your relay password + + * [weechat-android](https://github.com/ubergeek42/weechat-android) and [lith](https://github.com/lithapp/lith): + - connection type: websocket (ssl) + - websocket path: ~username/weechat + - relay host: tilde.club + - relay port: 443 + - your relay password + + - (if you get "Error: Could not connect using WebSocket", check to be sure + ~/ and ~/.weechat have at least o+rx permissions so nginx can reach + ~/.weechat/relay_socket) + ## IRC Bouncer (ZNC) You can find a ZNC IRC Bouncer by going to: [https://services.tilde.club/znc](https://services.tilde.club/znc).