doc/user/getting_started/check-environment.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Checking your environment"
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 First, log into an Arvados VM instance (instructions for "Webshell":{{site.baseurl}}/user/getting_started/vm-login-with-webshell.html or "Unix":{{site.baseurl}}/user/getting_started/ssh-access-unix.html#login or "Windows":{{site.baseurl}}/user/getting_started/ssh-access-windows.html#login) or install the Arvados "Command line SDK":{{site.baseurl}}/sdk/cli/install.html and "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html on your workstation.
  13
  14 Check that you are able to access the Arvados API server using @arv user current@.  If it is able to access the API server, it will print out information about your account:
  15
  16 <notextile>
  17 <pre><code>$ <span class="userinput">arv user current</span>
  18 {
  19  "href":"https://zzzzz.arvadosapi.com/arvados/v1/users/zzzzz-xioed-9z2p3pn12yqdaem",
  20  "kind":"arvados#user",
  21  "etag":"8u0xwb9f3otb2xx9hto4wyo03",
  22  "uuid":"zzzzz-tpzed-92d3kxnimy3d4e8",
  23  "owner_uuid":"zzzzz-tpqed-23iddeohxta2r59",
  24  "created_at":"2013-12-02T17:05:47Z",
  25  "modified_by_client_uuid":"zzzzz-xxfg8-owxa2oa2s33jyej",
  26  "modified_by_user_uuid":"zzzzz-tpqed-23iddeohxta2r59",
  27  "modified_at":"2013-12-02T17:07:08Z",
  28  "updated_at":"2013-12-05T19:51:08Z",
  29  "email":"you@example.com",
  30  "full_name":"Example User",
  31  "first_name":"Example",
  32  "last_name":"User",
  33  "identity_url":"https://www.google.com/accounts/o8/id?id=AItOawnhlZr-pQ_Ic2f2W22XaO02oL3avJ322k1",
  34  "is_active": true,
  35  "is_admin": false,
  36  "prefs":{}
  37 }
  38 </code></pre>
  39 </notextile>
  40
  41 However, if you receive the following message:
  42
  43 bc. ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables
  44
  45 follow the instructions for "getting an API token,":{{site.baseurl}}/user/reference/api-tokens.html and try @arv user current@ again.