doc/user/ssh-access.md

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Setting up SSH access
   5 navorder: 2
   6 ---
   7
   8 # Setting up SSH access
   9
  10 Arvados uses SSH public key authentication for two things:
  11
  12 * logging in to a VM, and
  13 * pushing code to a git repository.
  14
  15 If you don't already have an SSH key pair (or you don't know whether
  16 you do), there are lots of tutorials out there to help you get
  17 started:
  18
  19 * [github SSH key
  20 tutorial](https://www.google.com/search?q=github+ssh+key+help)
  21
  22 Once you have a public/private key pair, copy and paste the public key
  23 into Arvados Workbench's "add SSH key" box.
  24
  25 * A screen shot would be nice here.
  26
  27 On your workstation, add the following section to your `~/.ssh/config`
  28 file:
  29
  30     Host *.arvados
  31       ProxyCommand ssh turnout@9ujm1.arvados.org %h %p %u
  32       Port 2222
  33
  34 If you have access to an account `foo` on a VM called `blurfl` then
  35 you can log in like this:
  36
  37     ssh foo@blurfl.arvados
  38
  39 ### Another option for impatient and lazy people
  40
  41 If you want to shorten this and you always/usually have access to the
  42 `foo` account on VMs, you can add a section like this to
  43 `~/.ssh/config`:
  44
  45     Host *.a
  46       ProxyCommand ssh turnout@9ujm1.arvados.org %hrvados %p %u
  47       Port 2222
  48       User foo
  49
  50 Then you can log in to the `blurfl` VM as `foo` like this:
  51
  52     ssh blurfl.a
  53
  54 (Arvados Workbench will show you a list of VMs you have access to and
  55 what your account name is for each one.)
  56
  57 ### Setup instructions for PuTTY
  58
  59 If you use Microsoft Windows, you should download the PuTTY software.
  60
  61 * Details about configuring PuTTY would be nice here.