Repository navigation
docs: add Tailcat reachability guidance #89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
c22086f
0c12182
f164933
2d0ca24
a01317f
80c029f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,6 +34,37 @@ exactly as it carries a standalone server's address today. | |
| router port forward is then the host's own choice, and the invite exposes that address | ||
| to anyone who holds the link. | ||
|
|
||
| ## Tailcat without a tailnet | ||
|
|
||
| Tailcat carries the relay over WireGuard through DERP and NAT traversal. An editor or agent guest | ||
| uses the wire invite, the `ws://…/session?…` form. A page guest uses the same forward and keeps the | ||
| invite's `/page/` path. | ||
|
|
||
| Host: | ||
|
|
||
| 1. Start the room in the host client. Copy the invite URL. | ||
| 2. Read the port from the invite. In `ws://host:8080/session?…` it is `8080`. | ||
| 3. Run `tailcat serve 8080` with that port. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ensure the protected endpoint accepts loopback connections. If the host binds the endpoint only to its LAN address, as described above for same-LAN access,
|
||
| 4. Send the guest the printed `tc...` address, the port `8080`, and the full invite URL. | ||
|
|
||
| The invite ends with a fragment such as `#k=<room-key>&h=<host-key>`. It is part of the URL. The | ||
| guest must copy it unchanged. | ||
|
|
||
| Guest: | ||
|
|
||
| 1. Run `tailcat forward <tc-addr> 18080:8080`. | ||
| 2. Insert `127.0.0.1:18080` in place of the invite's `host:port`. Keep `/session`, the `?room=…&token=…` | ||
| query and the `#k=…&h=…` fragment. | ||
| 3. Open the new URL in the client: | ||
|
|
||
| ``` | ||
| ws://127.0.0.1:18080/session?room=<room-id>&token=<token>#k=<room-key>&h=<host-key> | ||
| ``` | ||
|
|
||
| Treat the `tc...` address and the invite as one secret. Rate-limit the relay. Restrict inbound | ||
| access to the host with a firewall. | ||
|
|
||
|
|
||
| Every invite leaks the address it carries. Treat the invite as the secret it already is: | ||
| the room key, the host public key and now the host's reachable address travel together. | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Select the local protected port, not necessarily the invite port.
If a router forwards public port 443 to local port 8443, these steps serve localhost:443 instead of the protected endpoint. A valid
https://host/page/invite can also omit the port. Tell the host to identify and share the local protected port; it can differ from the invite’s port. (rfc-editor.org)