Updated SSH (markdown)

master
Chad Bailey 2021-06-14 23:45:02 -05:00
parent 094cc7e74a
commit a8cc2e5347
1 changed files with 0 additions and 16 deletions

16
SSH.md

@ -4,22 +4,6 @@
**NOTE**: 🚧 openpilot 0.8.3 mandates usage of keys from a personal GitHub account and changes the SSH port from 8022 to 22. The content below is partially outdated for 0.8.3 and is in the process of being updated.
# Experienced Developer Quick Start
If you already know what you're doing, here's the abbreviated version:
## Experienced Developer Quick Start - SSH
1. Add your public key to [Github](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
2. Enable SSH in the comma settings & add your GitHub username via `Settings -> Developer -> GitHub Username`
3. SSH as root into your comma using the key published on GitHub. `ssh root@192.168.x.x`. NOTE: Must be LAN, SSH is inaccessible from WAN
## Experienced Developer Quick Start - Making Changes
1. The openpilot install is housed in `/data/openpilot`. The code can be modified in place, reboot after changes to see new changes.
2. The official release branch is `release2` which comes with precompiled binaries, but most branches do not have binaries. Other interesting branches include `master` (latest), `master-ci` (latest + submodules), `devel`, and `devel-staging`
3. Binaries are compiled at boot time assuming they aren't already supplied by the branch (device will take 20+ minutes to boot). To monitor the build, ssh in and attach to the tmux session via `tmux a`
4. Keep in mind that at the time of writing `/cereal`, `/laika_repo`, `/opendbc`, `/panda`, `/rednose_repo`, `/laika`, and `/rednose` are all submodules. If you wipe /data/openpilot and clone fresh be sure to issue the command `git submodule update --init --recursive` after cloning for a successful build.
If you don't understand these instructions or they didn't work, ~~get good~~ follow the next sections.
# Before You Start
1. You need a GitHub account. Make one.