Changeset 323 in code for trunk/doc/soju.1.scd

Timestamp:

Jun 7, 2020, 12:13:46 PM (5 years ago)

Author:

contact

Message:

Add support for WebSocket connections

WebSocket connections allow web-based clients to connect to IRC. This
commit implements the WebSocket sub-protocol as specified by the pending
IRCv3 proposal [1].

WebSocket listeners can now be set up via a "wss" protocol in the
listen directive. The new http-origin directive allows the CORS
allowed origins to be configured.

[1]: ​https://github.com/ircv3/ircv3-specifications/pull/342

File:

• trunk/doc/soju.1.scd (modified) (2 diffs)

trunk/doc/soju.1.scd

@@ -73 +73 @@
         - _irc+insecure://[host][:port]_ listens with plain-text over TCP (default
           port if omitted: 6667)
+        - _wss://[host][:port]_ listens for WebSocket connections over TLS (default
+          port: 443)
+        - _ws+insecure://[host][:port]_ listens for plain-text WebSocket
+          connections (default port: 80)
 
         If the scheme is omitted, "ircs" is assumed. If multiple *listen*
@@ -91 +95 @@
         Path to the bouncer logs root directory, or empty to disable logging. By
         default, logging is disabled.
+
+*http-origin* <patterns...>
+        List of allowed HTTP origins for WebSocket listeners. The parameters are
+        interpreted as shell patterns, see *glob*(7).
 
 # IRC SERVICE