-
Notifications
You must be signed in to change notification settings - Fork 4
Fix instructions for mounting Sprite over SSHFS #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
CLI Documentation Generator
📚 Commands documented
|
Preview Deployment
Commit: |
Lighthouse Results
|
E2E Test Results✅ Tests success Ran against: https://pr-88-superfly-sprites-docs.fly.dev |
f820b1b to
b6e0770
Compare
b6e0770 to
95db7fa
Compare
Review feedbackThe sprite exec -s my-sprite bash -c "mkdir -p .ssh && echo '$(cat ~/.ssh/id_*.pub)' >> .ssh/authorized_keys"This replaces both commands: sprite exec mkdir -p .ssh
cat ~/.ssh/id_*.pub | sprite exec tee -a .ssh/authorized_keysBenefits:
Alternative using the sprite exec -s my-sprite -f ~/.ssh/id_ed25519.pub:/tmp/key.pub bash -c "mkdir -p .ssh && cat /tmp/key.pub >> .ssh/authorized_keys"Also note the commands need |
Additional feedback: Add context for SSH setupThe section would benefit from explaining why all this setup is needed. The old docs implied you could SSH directly to Suggested intro text after the heading: ### Mounting Filesystem Locally
Use SSHFS to mount your Sprite and edit files with your local tools.
Sprites don't expose SSH directly—you'll need to install an SSH server on your
Sprite and tunnel the connection through `sprite proxy`. This keeps your Sprite
secure while still allowing local filesystem access.This sets expectations before users dive into the setup steps. |
Additional feedback: Clarify the
|
Additional feedback: Port collision issueHardcoding port 2000 means:
Consider deriving a unique port from the sprite name, or checking if already mounted before starting a new proxy. |
|
I originally had a cat command, but changed it to tee to demonstrate that piping to a Sprite was possible. I'll change it back to cat so we have working instructions. I'd love to revert it later :) The test is unnecessary since sprite proxy fails anyways. I'll remove it. As this is a throwaway example hidden at the bottom of the docs, I want to keep it as simple as possible. Dynamic ports in shell is doable but looks strange. I'll add a check to see if the port is occupied and ask the user if they want to close the existing mount. |
Note that the
sprite exec teecommand doesn't currently work (it will produce an invalid file and then hang). This is a bug with how sprite exec handles stdin for non-interactive commands. This should be fixed shortly.