@sockethub/platform-irc 4.0.0-beta.1 → 4.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -427,6 +427,27 @@ distinction clear:
427
427
  }
428
428
  ```
429
429
 
430
+ ### Private addresses
431
+
432
+ The platform refuses to connect to loopback, private, link-local, and cloud
433
+ metadata addresses, using the same address rules as the
434
+ [outbound URL guard](../../docs/configuration.md#outbound-url-guard). To reach
435
+ an IRC server on a private network, set `allowPrivateAddresses` in this
436
+ platform's `packageConfig` entry:
437
+
438
+ ```json
439
+ {
440
+ "packageConfig": {
441
+ "@sockethub/platform-irc": {
442
+ "allowPrivateAddresses": true
443
+ }
444
+ }
445
+ }
446
+ ```
447
+
448
+ Do not enable it on a server that accepts untrusted clients. Any client could
449
+ then make Sockethub connect to internal services.
450
+
430
451
  ## Messages and CTCP
431
452
 
432
453
  A normal `send` is a channel or private `PRIVMSG`. The request schema only