-
Notifications
You must be signed in to change notification settings - Fork 706
docs: usage: split SSH to a separate page #4182
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
Open
AkihiroSuda
wants to merge
1
commit into
lima-vm:master
Choose a base branch
from
AkihiroSuda:docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+48
−28
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
title: SSH | ||
weight: 3 | ||
--- | ||
|
||
Instead of the `limactl shell` command, SSH can be used too: | ||
|
||
```console | ||
$ limactl ls --format='{{.SSHConfigFile}}' default | ||
/Users/example/.lima/default/ssh.config | ||
|
||
$ ssh -F /Users/example/.lima/default/ssh.config lima-default | ||
``` | ||
|
||
This is useful for interoperability with other software that expects the SSH connectivity. | ||
|
||
## Using SSH without additional options | ||
|
||
Add the following line to your `~/.ssh/config`: | ||
|
||
``` | ||
Include ~/.lima/*/ssh.config | ||
``` | ||
|
||
Then you can connect directly without specifying `-F`: | ||
```bash | ||
ssh lima-default | ||
``` | ||
|
||
This configuration is notably useful for the Remote Development mode of [Visual Studio Code](../examples/vscode.md). | ||
|
||
## Using SSH without a config file | ||
|
||
If your SSH client does not support a config file, try specifying an equivalent of the following command: | ||
|
||
```bash | ||
ssh -p <PORT> -i ~/.lima/_config/user -o NoHostAuthenticationForLocalhost=yes 127.0.0.1 | ||
``` | ||
|
||
The port number can be inspected as follows: | ||
```bash | ||
limactl list --format '{{ .SSHLocalPort }}' default | ||
``` | ||
|
||
See also `.lima/default/ssh.config`. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RFC: this should be under https://lima-vm.io/docs/usage/ ("Must read") or https://lima-vm.io/docs/config/ ("Read on demand")
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having SSH on a separate page looks much better