Skip to content

Update tunnel docs for offline mode and auto-port-config#5179

Open
Shannon Bradshaw (shannonbradshaw) wants to merge 2 commits into
mainfrom
claude/update-tunnel-cli-offline-autoconfig-2026-07-11
Open

Update tunnel docs for offline mode and auto-port-config#5179
Shannon Bradshaw (shannonbradshaw) wants to merge 2 commits into
mainfrom
claude/update-tunnel-cli-offline-autoconfig-2026-07-11

Conversation

@shannonbradshaw

Copy link
Copy Markdown
Collaborator

Summary

Update tunneling documentation to reflect two RDK changes that shipped on 2026-07-10:

  1. Offline/direct tunneling (rdk#6212): viam machines part tunnel now accepts --address, --key-id, and --key flags. When all three are provided, the CLI dials the machine directly without contacting app.viam.com, enabling tunneling on machines with no internet access.

  2. Auto-configure tunnel ports (rdk#6204): The CLI now automatically adds the destination port to the machine's traffic_tunnel_endpoints config when the port isn't already allowed. Users no longer need to manually edit the machine config before tunneling.

Source changes

Docs changes

  • docs/cli/reference.md: Updated machines part tunnel section with new description, two example commands (default and direct), and three new optional flags in the argument table. Removed the incorrect claim that ports must be manually configured.
  • docs/fleet/system-settings.md: Updated tunneling section to note that the CLI auto-adds ports. Added a direct-tunneling CLI example.
  • docs/cli/manage-your-fleet.md: Added auto-config note and direct-tunneling example to the "Create a tunnel" section.

How I found these

  • Xref lookup: cli-xref.md for machines part tunnel
  • Grep matches: 6 docs pages reference tunneling; 3 needed updating

Generated by daily docs change agent


Generated by Claude Code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E46cVmU8tP3pJ1pzviLmzv
@netlify

netlify Bot commented Jul 11, 2026

Copy link
Copy Markdown

Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 141bae7
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6a54fdace837130008fcff53
😎 Deploy Preview https://deploy-preview-5179--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🟢 up 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 11, 2026
@btshrewsbury-viam

Copy link
Copy Markdown
Collaborator

Ethan (@stuqdog) Would you mind reviewing this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants