ssh docs: corrections and readability improvements (#25482)

* Corrections and readability improvements

* Apply suggestions from code review

Co-authored-by: Shane Smiskol <shane@smiskol.com>
pull/25483/head
Erich Moraga 3 years ago committed by GitHub
parent 747bcb013d
commit 6a3a9944c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 9
      tools/ssh/README.md

@ -7,11 +7,11 @@ In order to SSH into your device, you'll need a GitHub account with SSH keys. Se
* Enable SSH in your device's settings
* Enter your GitHub username in the device's settings
* Connect to your device
* Username: `comma` (comma three)
* Username: `comma`
* Port: `22` or `8022`
Here's an example command for connecting to your device using its tethered connection:
`ssh root@192.168.43.1`
Here's an example command for connecting to your device using its tethered connection:<br />
`ssh comma@192.168.43.1`
For doing development work on device, it's recommended to use [SSH agent forwarding](https://docs.github.com/en/developers/overview/using-ssh-agent-forwarding).
@ -34,7 +34,8 @@ Requires [comma SIM with comma prime](https://comma.ai/shop) activated with comm
## Recommended .ssh/config
With the below ssh configuration, you can type `ssh comma-{dongleid}` to connect to your device through `ssh.comma.ai`. For example, `ssh comma-ffffffffffffffff`.
With the below SSH configuration, you can type `ssh comma-{dongleid}` to connect to your device through `ssh.comma.ai`.<br />
For example: `ssh comma-ffffffffffffffff`
```
Host comma-*

Loading…
Cancel
Save