docs(manual): add remote access page (SSH tunnel, Tailscale)#34
Merged
Conversation
Explains the two supported ways to reach a node's local API from off-LAN: SSH port-forward (no config change, safest default) and extending the source-IP allowlist for a private overlay such as Tailscale or WireGuard via the new --allowed-source-cidrs option in freenet/freenet-core#3875. Pairs with freenet-core PR #3875; should land at roughly the same time so the docs don't reference a flag the released binary doesn't yet understand. [AI-assisted - Claude]
Address big-picture review finding on #34: the filter is only installed when `ws-api-address` is non-loopback, so the TOML snippet's `allowed-source-cidrs` has no effect if the bind address is left at the default. Spell this out in the Option 2 step. [AI-assisted - Claude]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
freenet.org has no page explaining how a user can reach their own node's local HTTP/WebSocket API (port 7509) from a device that isn't on the same LAN. The only hint is a passing mention of `--node-url 127.0.0.1:7509` in publish-a-website.md. Users who want to use their node from a phone end up asking on Matrix instead.
Approach
New page `build/manual/remote-access.md` covering:
Linked from `_index.md` under Developer Guide.
Coordination
Pairs with freenet/freenet-core#3875. The doc references a CLI flag and config field (`--allowed-source-cidrs` / `allowed-source-cidrs`) that don't exist in the currently released binary. Should merge at roughly the same time as #3875 lands, ideally right after the next freenet-core release that contains it, so users don't try the documented flag against an old build and see clap reject it.
Testing
[AI-assisted - Claude]