Skip to content

docs: add AllowTcpForwarding prerequisite to Hetzner SSH tunnel step#1397

Open
BingqingLyu wants to merge 2 commits into
mainfrom
fork-pr-54564-docs-hetzner-ssh-tcp-forwarding
Open

docs: add AllowTcpForwarding prerequisite to Hetzner SSH tunnel step#1397
BingqingLyu wants to merge 2 commits into
mainfrom
fork-pr-54564-docs-hetzner-ssh-tcp-forwarding

Conversation

@BingqingLyu

@BingqingLyu BingqingLyu commented Apr 27, 2026

Copy link
Copy Markdown
Owner

Summary

  • Problem: The Hetzner guide recommends accessing the gateway via SSH tunnel but does not mention that AllowTcpForwarding must be enabled in the VPS sshd config for this to work.
  • Why it matters: Users with hardened SSH configs hit a silent, cryptic failure - channel 3: open failed: administratively prohibited: open failed - with no indication that sshd config is the cause.
  • What changed: Added a prerequisite note to the SSH tunnel step in the Hetzner guide explaining the AllowTcpForwarding setting, the exact error they will see if it is disabled, and a systemctl restart sshd reminder.
  • What did NOT change: No code changes. Docs only.

Change Type (select all)

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope (select all touched areas)

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

Root Cause / Regression History (if applicable)

N/A - docs gap, not a regression.

Regression Test Plan (if applicable)

N/A

User-visible / Behavior Changes

Users following the Hetzner guide now see a prerequisite note about AllowTcpForwarding before the tunnel command.

Security Impact (required)

  • New permissions/capabilities? No
  • Secrets/tokens handling changed? No
  • New/changed network calls? No
  • Command/tool execution surface changed? No
  • Data access scope changed? No

Repro + Verification

Environment

  • OS: Hetzner Ubuntu 22.04 VPS with hardened sshd config
  • Runtime/container: N/A (docs only)

Steps

  1. Follow Hetzner guide with hardened sshd (AllowTcpForwarding no)
  2. Run ssh -N -L 18789:127.0.0.1:18789 root@YOUR_VPS_IP
  3. See channel 3: open failed: administratively prohibited: open failed

Expected

  • Docs warn about this requirement before the tunnel command

Actual (before fix)

  • No mention of AllowTcpForwarding anywhere in the guide

Evidence

Human Verification (required)

  • Verified scenarios: confirmed the exact error message matches the issue report and that AllowTcpForwarding local is the minimal safe setting for this use case
  • Edge cases checked: AllowTcpForwarding yes also works but is broader than needed; local is the right recommendation for this setup
  • What you did not verify: live VPS test (docs-only change)

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

Compatibility / Migration

  • Backward compatible? Yes
  • Config/env changes? No
  • Migration needed? No

Failure Recovery (if this breaks)

  • How to disable/revert this change quickly: Revert docs/install/hetzner.md
  • Known bad symptoms reviewers should watch for: None

Risks and Mitigations

None - docs-only change.

Users with hardened sshd configs hit a silent failure when attempting the
SSH tunnel. Add a prerequisite note explaining the AllowTcpForwarding setting
and the error message they will see if it is disabled.

Closes openclaw#54557
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.

[Feature]: Hetzner guide: SSH tunnel requires AllowTcpForwarding to be enabled in sshd config

2 participants