doc/user/index.md

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Getting started
   5 navorder: 0
   6 ---
   7
   8 # Getting started
   9
  10 As a new user, you should take a quick tour of Arvados environment.
  11
  12
  13 ### Log in to Workbench
  14
  15 Open a browser and point it to the Workbench URL for your site. It
  16 will look something like this:
  17
  18 `https://workbench.a123z.arvados.org/`
  19
  20 Depending on site policy, a site administrator might have to activate
  21 your account before you see any more good stuff.
  22
  23 ### Browse shared data and pipelines
  24
  25 On the Workbench home page, you should see some datasets, programs,
  26 jobs, and pipelines that you can explore.
  27
  28 ### Install the command line SDK on your workstation
  29
  30 (Optional)
  31
  32 Most of the functionality in Arvados is exposed by the REST API. This
  33 means (depending on site policy and firewall) that you can do a lot of
  34 stuff with the command line client and other SDKs running on your own
  35 computer.
  36
  37 Technically you can make all API calls using a generic web client like
  38 [curl](http://curl.haxx.se/docs/) but you will have a more enjoyable
  39 experience with the Arvados CLI client.
  40
  41     echo "deb http://apt.arvados.org/apt precise main contrib non-free" \
  42       | sudo tee -a /etc/apt/sources.list.d/arvados.list
  43     wget -q http://apt.arvados.org/53212765.key -O- \
  44       | sudo apt-key add -
  45     sudo apt-get update
  46     sudo apt-get install arvados-cli
  47
  48 ### Request a virtual machine
  49
  50 It's more fun to do stuff with a virtual machine, especially if you
  51 know about [screen](http://www.gnu.org/software/screen/).
  52
  53 In order to get access to an Arvados VM, you need to:
  54
  55 1. Upload an SSH public key ([learn how](ssh-keys.html))
  56 1. Request a new VM (or access to a shared VM)
  57