Skip to content

docs: reconcile socat bridge claims (verified on VM), fix Unraid template - #19

Merged
libre-7 merged 1 commit into
mainfrom
docs/socat-reconcile-template
Aug 24, 2026
Merged

docs: reconcile socat bridge claims (verified on VM), fix Unraid template#19
libre-7 merged 1 commit into
mainfrom
docs/socat-reconcile-template

Conversation

@libre-7

@libre-7 libre-7 commented Aug 24, 2026

Copy link
Copy Markdown
Owner

Summary

Resolves the socat documentation contradiction flagged in the 2026-08-23 review.

Verified behavior (tested live on a VM against the v1.0.1 image, bridge networking, published host port):

  • socat bridge mode WORKS end-to-end: full WebSocket handshake (HTTP/1.1 101 Switching Protocols) through the published port.
  • Critical caveat found during testing: SIMPLEX_SOCAT_PORT=5225 — as both README and the Unraid template previously instructed — ALWAYS fails with socat[...] E bind(5, {AF=2 0.0.0.0:5225}, 16): Address already in use, because the daemon itself already binds 127.0.0.1:5225. The port must be anything else (e.g. 5226).

Changes

  • README Network Configuration: replaced "under investigation / not yet confirmed" with verified behavior + must-differ-from-5225 caveat + unauthenticated-API warning.
  • README env table + multi-bot FAQ updated consistently (single consistent statement everywhere).
  • templates/simplex-bridge.xml Overview corrected to match; SIMPLEX_SOCAT_PORT description now says MUST differ from 5225 and warns about no auth.
  • Port 5225 field annotated as informational-only under default host networking.
  • Added dated 2026.08.24 Changes entry.

…mplate

- Verified on VM (v1.0.1 image): socat bridge works end-to-end via bridge
  networking + published port (full WS 101 handshake). Critical caveat:
  SIMPLEX_SOCAT_PORT must differ from 5225 — the daemon already binds
  127.0.0.1:5225, so socat's bind of 5225 fails 'Address already in use'.
  Both README and template previously recommended 5225.
- README Network Configuration now states verified behavior + auth warning;
  env table and multi-bot FAQ updated consistently; removed 'under
  investigation / not confirmed' language.
- Template Overview corrected to match; SIMPLEX_SOCAT_PORT description
  updated with must-differ-from-5225 + unauthenticated warning.
- Port 5225 field annotated as informational-only under host networking.
- Added dated Changes entry.
@libre-7
libre-7 merged commit 8cc33bd into main Aug 24, 2026
2 checks passed
libre-7 added a commit that referenced this pull request Aug 24, 2026
docs: reconcile socat bridge claims (verified on VM), fix Unraid template
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants