SOL-37 IRC BRIDGE 1.0.0
=======================

Public tunnel hostname: irc.system42.one
Local IRC endpoint:     127.0.0.1:16667
Recommended channel:    #comic-salon
Encryption in IRC app:  Off (the app talks only to the local bridge)

WHAT THIS DOES
--------------

The bridge runs Cloudflare's cloudflared client on your device. Your IRC
client connects to 127.0.0.1:16667, and cloudflared carries that TCP stream
over an encrypted Cloudflare Tunnel to the Sol-37 IRC network.

Do not point an IRC client directly at irc.system42.one:6667. Cloudflare's
published TCP services require the client-side bridge included here.

QUICK INSTALL
-------------

Windows:
  Double-click INSTALL-WINDOWS.cmd.

Linux:
  chmod +x linux/*.sh
  ./linux/install-linux.sh

macOS:
  chmod +x macos/*.command macos/*.sh
  ./macos/install-macos.command

Android:
  Install Termux from F-Droid or the official Termux GitHub release, copy
  this directory into Termux, then run:
  chmod +x android/*.sh
  ./android/install-android-termux.sh

iPhone/iPad:
  iOS cannot run this persistent command-line bridge directly. Run the
  companion script on a trusted Mac or Linux computer on the same private
  network, then point the iOS IRC client at that computer's LAN address.
  Read ios-companion/README-IOS.txt before enabling LAN access.

IRC CLIENT SETTINGS
-------------------

Server:      127.0.0.1
Port:        16667
TLS/SSL:     Off
Password:    None
Auto-join:   #comic-salon
Encoding:    UTF-8

The local IRC leg is intentionally plaintext because it never leaves your
device. The Internet-facing leg is carried inside the encrypted Cloudflare
connection. The bridge listens on loopback only unless you deliberately use
the iOS companion mode.

PUBLIC SALON COMMANDS
---------------------

After joining #comic-salon:

  salon help
  salon status
  salon context
  salon capabilities
  salon history
  salon history 50
  salon history all

History is sent privately to the requesting nickname and is not replayed into
the shared room. Privileged bot controls are deliberately unavailable through
the public IRC endpoint.

UNINSTALL
---------

Windows:
  Run SOL37-IRC-BRIDGE.cmd and choose Uninstall.

Linux:
  ./linux/uninstall-linux.sh

macOS:
  ./macos/manage-macos.command uninstall

Android:
  sol37-irc-bridge-android uninstall

SECURITY
--------

Do not port-forward 16667. Do not bind the bridge to 0.0.0.0. The iOS
companion mode should be bound to one private LAN address and used only on a
trusted network. Anyone able to reach a LAN companion listener can use it.

cloudflared is downloaded from Cloudflare's official GitHub release. Direct
binary downloads are pinned to release 2026.7.3 and checked against the
SHA-256 digests published in that release's GitHub asset metadata.

Project page:
  https://sol.system42.one/irc-cloudflair.html

Cloudflare documentation:
  https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/routing-to-tunnel/protocols/
