Skip to content

docs(http): document HTTP/3 support via reverse proxy#1766

Merged
josecelano merged 8 commits into
torrust:developfrom
josecelano:1736-docs-http3-proxy-follow-up
May 12, 2026
Merged

docs(http): document HTTP/3 support via reverse proxy#1766
josecelano merged 8 commits into
torrust:developfrom
josecelano:1736-docs-http3-proxy-follow-up

Conversation

@josecelano
Copy link
Copy Markdown
Member

Summary

Adds documentation for running HTTP/3 via a reverse proxy in front of the Torrust tracker's HTTP server, and introduces a follow-up issue spec for evaluating native HTTP/3 support.

Changes

  • docs/containers.md — New section ### HTTP/3 at the edge with a reverse proxy covering:

    • Why HTTP/3 terminates at the proxy (Axum/hyper do not yet support HTTP/3)
    • Caddy config example matching the format used in the official demo
    • Operational guidance and manual verification commands (curl --http3)
    • Link to the demo Caddy config for a real-world reference
  • docs/issues/open/1736-docs-http3-proxy.md — Spec for this issue (all tasks and ACs done)

  • docs/issues/open/1765-native-http3-readiness.md — Follow-up spec for native HTTP/3 evaluation (linked to GitHub issue feat(http-tracker): evaluate and implement native HTTP/3 support #1765, status: blocked pending hyperium/h3 stabilisation)

  • docs/issues/README.md, docs/issues/open/README.md, docs/issues/closed/README.md, docs/issues/drafts/README.md — Reduced duplication; added top-level index

  • AGENTS.md — Added policy refactor: port udp to aquatic_udp_protocol #6: documentation single-source-of-truth

  • .github/agents/ — Split monolithic reviewer.agent.md into task-reviewer.agent.md (pre-PR acceptance validation) and pr-reviewer.agent.md (GitHub PR review only); updated implementer.agent.md to call @task-reviewer

  • .github/skills/dev/task-reviews/review-task/SKILL.md — New task-review skill

  • project-words.txt — Added QUIC, hyperium, nghttp, ngtcp

Related issues

Closes #1736
Refs #1765

 and torrust#1765

Move 1736-docs-http3-proxy and 1737-native-http3-readiness from
docs/issues/drafts/ to docs/issues/open/, renaming the follow-up spec
to match its real GitHub issue number (torrust#1765).

Update both specs with:
- Real GitHub issue numbers (torrust#1736 and torrust#1765)
- Updated spec-path, status (open), and last-updated-utc in frontmatter
- Cross-links between the two related specs
- Workflow checkpoints marked complete
- Progress log entries added
@josecelano josecelano requested a review from a team as a code owner May 12, 2026 16:41
@josecelano josecelano self-assigned this May 12, 2026
@josecelano josecelano requested a review from Copilot May 12, 2026 16:42
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for offering HTTP/3 via an edge reverse proxy in front of the tracker’s existing HTTP stack, and refactors the repo’s “agent/skill” documentation to reduce duplicated workflow guidance while introducing a dedicated pre-PR task review workflow.

Changes:

  • Document HTTP/3 edge termination via reverse proxy (Caddy example + verification commands) in docs/containers.md.
  • Add/organize issue-spec documentation structure and introduce issue specs for #1736 and follow-up #1765.
  • Split the previous monolithic reviewer agent into dedicated task-review vs PR-review agents/skills; update AGENTS.md policy to prefer single-source workflow docs.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
project-words.txt Adds HTTP/3-related terms and keeps the word list sorted.
docs/issues/README.md Introduces a top-level index for issue specifications and points to canonical skills.
docs/issues/open/README.md Removes duplicated lifecycle steps; links to the canonical skills and index.
docs/issues/open/1765-native-http3-readiness.md Adds follow-up issue spec for evaluating native HTTP/3 readiness.
docs/issues/open/1736-docs-http3-proxy.md Adds issue spec for documenting HTTP/3 via reverse proxy and tracking completion.
docs/issues/drafts/README.md Adds a lightweight purpose/navigation README for draft specs.
docs/issues/closed/README.md Removes duplicated lifecycle text; links to canonical cleanup skill.
docs/containers.md Adds a new section describing HTTP/3 via edge proxy + Caddy example + manual verification.
AGENTS.md Adds a “documentation single source of truth” policy.
.github/skills/dev/task-reviews/review-task/SKILL.md Adds a new pre-PR task review skill/checklist.
.github/skills/dev/pr-reviews/review-pr/SKILL.md Clarifies that review-pr applies only to already-open PRs; points to review-task otherwise.
.github/agents/task-reviewer.agent.md Adds a dedicated Task Reviewer agent for pre-PR acceptance verification.
.github/agents/reviewer.agent.md Removes the previous monolithic Reviewer agent definition.
.github/agents/pr-reviewer.agent.md Adds a dedicated PR Reviewer agent for PR-only review workflow.
.github/agents/implementer.agent.md Updates the implementer workflow to invoke @task-reviewer prior to committing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/agents/implementer.agent.md Outdated
Comment thread docs/containers.md
Comment thread docs/containers.md Outdated
Comment thread docs/issues/README.md Outdated
- Add note that tracker must have `core.net.on_reverse_proxy = true`
  for X-Forwarded-For to be trusted (blocker: silently wrong peer IPs
  without this setting)
- Add clarification that manual verification commands use the demo
  hostname and should be replaced with the operator's own hostname
- Fix terminology: 'Reviewer' -> 'Task Reviewer' in implementer agent
  step 4 (consistency with step 5 and surrounding prose)
- Fix heading capitalisation: 'Source Of Truth' -> 'Source of Truth'
  in docs/issues/README.md
@josecelano
Copy link
Copy Markdown
Member Author

ACK 3449801

@josecelano josecelano merged commit 244c94e into torrust:develop May 12, 2026
1 check 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.

docs(http): document HTTP/3 support via reverse proxy and track native HTTP/3 follow-up

2 participants