Skip to content

Add SSH access template documentation#100

Merged
beran-t merged 16 commits into
mainfrom
ssh-template-docs
Feb 4, 2026
Merged

Add SSH access template documentation#100
beran-t merged 16 commits into
mainfrom
ssh-template-docs

Conversation

@beran-t
Copy link
Copy Markdown
Contributor

@beran-t beran-t commented Feb 4, 2026

Summary

Adds documentation for enabling SSH access to E2B sandboxes using websocat as a WebSocket-to-SSH proxy.

Changes

  • New SSH access guide: docs/sandbox/ssh-access.mdx
  • Updated navigation in docs.json

Documentation includes

  • Step-by-step Quickstart using Mintlify Steps component
  • Template definition and build code (TypeScript and Python)
  • Sandbox creation examples
  • Architecture diagram explaining the WebSocket proxy flow
  • Manual setup instructions for quick testing without a template

Adds a new template example showing how to enable SSH access to E2B
sandboxes using websocat as a WebSocket-to-SSH proxy. This is a manual
workaround while native SSH support is in development.

Includes:
- Template definition for SSH-ready sandbox
- Quick start guide for CLI users
- Connection methods (websocat and curl)
- SSH config shortcut for easier access
- SSH key authentication setup
- SCP file transfer examples
…tart time

Tested and verified working:
- Template builds successfully
- SSH connection works with websocat proxy
- Password authentication with user:sandbox credentials
- Remove separate ssh-ready template example page
- Move template code into Quickstart using Mintlify Steps component
- Add sandbox creation step with SDK examples
- Fix title casing: "SSH Access" → "SSH access"
- Remove warning callout and PTY note
- Fix diagram alignment in E2B Sandbox section
- Use CodeGroup instead of Tabs for OS-specific commands
- Move overview text to page intro
@beran-t beran-t merged commit 2019b42 into main Feb 4, 2026
5 checks passed
@beran-t beran-t deleted the ssh-template-docs branch February 4, 2026 22:39
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.

2 participants