X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/2d4263c16812a906589cbc13be26535a85691bd8..8b3c15dfb7727baae8a81613488f121758c685a7:/doc/user/ssh-access.md?ds=inline diff --git a/doc/user/ssh-access.md b/doc/user/ssh-access.md index b9c9ba7f32..572bc118f1 100644 --- a/doc/user/ssh-access.md +++ b/doc/user/ssh-access.md @@ -12,6 +12,8 @@ Arvados uses SSH public key authentication for two things: * logging in to a VM, and * pushing code to a git repository. +### Generate a public/private SSH key pair + If you don't already have an SSH key pair (or you don't know whether you do), there are lots of tutorials out there to help you get started: @@ -19,42 +21,52 @@ started: * [github SSH key tutorial](https://www.google.com/search?q=github+ssh+key+help) -Once you have a public/private key pair, copy and paste the public key -into Arvados Workbench's "add SSH key" box. +### Associate your SSH public key with your Arvados Workbench account + +Go to the `Keys` page in Arvados Workbench (under the `Access` tab) and click the + +

Add a new authorized key

+ +button. Then click on 'none' in the public_key column, and copy and paste your public key: + +![Screen shot of the ssh public key box]({{ site.baseurl }}/images/ssh-adding-public-key.png) -* A screen shot would be nice here. +Click on the checkmark button to save your public key. + +### Unix-like systems: set up an ~/.ssh/config snippet for quick ssh access + +**Please make sure to replace {{ site.arvados_api_host }} with your arvados hostname in the examples below.** On your workstation, add the following section to your `~/.ssh/config` file: Host *.arvados - ProxyCommand ssh turnout@9ujm1.arvados.org %h %p %u - Port 2222 + ProxyCommand ssh -p2222 turnout@switchyard.{{ site.arvados_api_host }} -x -a $SSH_PROXY_FLAGS %h If you have access to an account `foo` on a VM called `blurfl` then you can log in like this: ssh foo@blurfl.arvados -### Another option for impatient and lazy people - If you want to shorten this and you always/usually have access to the `foo` account on VMs, you can add a section like this to `~/.ssh/config`: Host *.a - ProxyCommand ssh turnout@9ujm1.arvados.org %hrvados %p %u - Port 2222 + ProxyCommand ssh -p2222 turnout@switchyard.{{ site.arvados_api_host }} -x -a $SSH_PROXY_FLAGS %h User foo Then you can log in to the `blurfl` VM as `foo` like this: ssh blurfl.a -(Arvados Workbench will show you a list of VMs you have access to and -what your account name is for each one.) +Arvados Workbench will show you a list of VMs you have access to and +what your account name is for each one: click "VMs" in the "Access" +menu. + +### Windows: Setup instructions for PuTTY -### Setup instructions for PuTTY +{% include alert-stub.html %} If you use Microsoft Windows, you should download the PuTTY software.