Skip to content

Introduce OpenTunnel in the testing docs - #1300

Merged
dahlia merged 1 commit into
fedify-dev:2.4-maintenancefrom
dahlia:docs/opentunnel
Oct 14, 2026
Merged

dahlia merged 1 commit into
fedify-dev:2.4-maintenancefrom
dahlia:docs/opentunnel

Conversation

@dahlia

@dahlia dahlia commented Oct 14, 2026

Copy link
Copy Markdown
Member

This adds OpenTunnel to Exposing a local server to the public in docs/manual/test.md, with a subsection of its own.

OpenTunnel terminates TLS locally and passes the decrypted bytes to the local server unchanged, without adding X-Forwarded-Proto or other forwarding headers (trust boundary notes). The x-forwarded-fetch tip therefore doesn't help: the app sees plain HTTP, so Fedify builds http:// URLs. Since the tunnel hostname survives restarts, the subsection recommends setting origin to the tunnel URL instead. It also warns against treating requests as local, since every request comes from the loopback address.

To keep Hongdown from rewriting the heading as “Opentunnel,” OpenTunnel is added to proper_nouns in .hongdown.toml.

OpenTunnel is a tunneling tool from Anomaly that gives a machine
a persistent hostname under opentunnel.xyz and terminates TLS locally.
This adds it to the list of tools for exposing a local server in the
testing manual, along with a short subsection on how to use it.

Unlike the other tools listed there, the OpenTunnel client forwards
the decrypted bytes unchanged and adds no X-Forwarded-* headers, so
the x-forwarded-fetch middleware does not help.  The subsection
therefore recommends setting the origin option to the tunnel URL
instead, and warns that requests arrive from the loopback address.

OpenTunnel is also added to the Hongdown proper nouns so that the
heading keeps its casing.

https://github.com/anomalyco/opentunnel

Assisted-by: Claude Code:claude-opus-5-5
@dahlia dahlia self-assigned this Oct 14, 2026
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: e5160f33-30a1-449c-8d47-8c8c9b7b1c3c
📥 Commits

Reviewing files that changed from the base of the PR and between 0c5c366 and 86db6b9.

📒 Files selected for processing: 2
  • .hongdown.toml
  • docs/manual/test.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

The testing manual now documents OpenTunnel as an option for exposing a local server. It covers installation, routing, federation configuration, and access behavior. The heading proper-noun list also includes OpenTunnel.

Changes: OpenTunnel testing guide

Layer / File(s) Summary
Document OpenTunnel setup and use
docs/manual/test.md, .hongdown.toml
The manual lists OpenTunnel and links to its project. It describes installation, route setup, persistent public URLs, and setting FederationOptions.origin because forwarded requests lack proxy headers. It warns that route URLs are public and requests appear to come from loopback. The heading proper-noun list includes OpenTunnel.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 86db6

No actionable merge risk remains in this documentation change.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Description check Passed The description accurately summarizes the OpenTunnel documentation changes and the related configuration update.
Title check Passed The title clearly and concisely identifies the main change: adding OpenTunnel to the testing documentation.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T15:18:20.296956Z 86db6b9 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@codecov

codecov Bot commented Oct 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.
see 13 files with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dahlia
dahlia merged commit 7b61afc into fedify-dev:2.4-maintenance Oct 14, 2026
23 checks passed
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.

1 participant