docs: update SSH documentation with phala ssh command#134
Merged
Conversation
- Rewrite enable-ssh-access.mdx with phala ssh as primary method - Add CLI reference page for phala ssh command - Clarify SSH key injection timing (only at CVM creation) - Simplify debug-your-application.mdx - Update troubleshooting with phala ssh -v debugging 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
h4x3rotab
force-pushed
the
docs/update-ssh-documentation
branch
from
261c61f to
551ebcb
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
211
to
221
|
|
||
| SSH only works with development OS images. Production images have SSH disabled. | ||
|
|
||
| ### Check Configuration | ||
| ### Debug with Verbose Mode | ||
|
|
||
| Use the Phala CLI with verbose output to diagnose connection issues: | ||
|
|
||
| ```bash | ||
| # Verify environment variables are set | ||
| DSTACK_ROOT_PASSWORD=yourpassword | ||
| # OR | ||
| DSTACK_ROOT_PUBLIC_KEY=ssh-rsa AAAA... | ||
| phala ssh my-cvm -v | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Bug: The troubleshooting guide incorrectly uses ssh my-cvm instead of the required wrapper command phala ssh my-cvm, which will cause the connection to fail.
Severity: HIGH
Suggested Fix
In phala-cloud/networking/troubleshooting.mdx, change the command ssh my-cvm to phala ssh my-cvm to ensure it functions correctly and is consistent with the rest of the documentation.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: phala-cloud/networking/troubleshooting.mdx#L211-L221
Potential issue: In the "Connection Refused" section of the troubleshooting guide, the
"Quick Checks" subsection provides an incorrect SSH command: `ssh my-cvm`. This command
will fail because CVMs are only accessible through the Phala gateway tunnel, which
requires the `phala ssh` CLI wrapper. Users following these steps to diagnose connection
problems will be blocked, unable to access their CVM to perform further diagnostics.
This contradicts the documented standard `phala ssh` command used elsewhere in the
documentation.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
phala sshas primary methodphala sshcommandTest plan
phala sshexamples are accurate🤖 Generated with Claude Code