doc/user/index.textile

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Getting started
   5 navorder: 0
   6 ---
   7
   8 h1. Welcome to Arvados!
   9
  10 This guide is intended to introduce new users to the Arvados system.  It covers initial configuration required to use the system and then presents several tutorial on using Arvados to do data processing.
  11
  12 h2. Prerequisites
  13
  14 To get the most value out of this guide, you should be comfortable with the following:
  15
  16 # Using the unix command line shell @bash@
  17 # Using secure shell (@ssh@) to log on to a remote server
  18 # Programming in @python@
  19
  20 It will also be helpful (but not essential) if you are familiar with revision control using @git@.
  21
  22 The examples in this guide uses the public Arvados instance located at "https://workbench.{{ site.arvados_api_host }}/":https://workbench.{{ site.arvados_api_host }}/ .  You must have an account in order to use this service.  If you would like to request an account, please send an email to "arvados@clinicalfuture.com":mailto:arvados@clinicalfuture.com .
  23
  24 If you are using a different Arvados instance, get your user name and password from your local administrator, and replace @{{ site.arvados_api_host }}@ with your private instance in all of the examples in this guide.
  25
  26 h1. Arvados Workbench
  27
  28 You may access the Arvados workbench using this link:
  29
  30 "https://workbench.{{ site.arvados_api_host }}/":https://workbench.{{ site.arvados_api_host }}/
  31
  32 If you are accessing Arvados for the first time, you will be asked to log in using a Google account.  Arvados only uses Google services for identification, and will never access any personal information.  Once you are logged in, the Workbench page may indicate your account status is *New / inactive*.  If this is the case, contact the administrator of the Arvados instance to activate your account.
  33
  34 Once your account is active, logging in to the Workbench will present you with a system status dashboard.  This gives a summary of data, configuration, and activity in the Arvados instance.
  35
  36 Next, we will configure your account to enable @ssh@ access to an Arvados virtual machine (VM) instance.
  37
  38 h2(#settingupssh). Setting up ssh keys
  39
  40 Open the Workbench dashboard and look at the *Configuration* box.  It should show:
  41
  42 @ SSH keys   0 @
  43
  44 This indicates that you have not yet provided Arvados with a public @ssh@ key.  Arvados requires a public @ssh@ key in order to securely log in to an Arvados VM instance, or to access an Arvados @git@ repository.  Refer to "Getting your ssh key":ssh-access.html and then copy the contents of the public key file (@id_rsa.pub@) to the clipboard.
  45
  46 Access %(rarr)&rarr;% Keys
  47