11823: update collection lifecycle documentation to use "index" action instead of...
[arvados.git] / doc / user / getting_started / check-environment.html.textile.liquid
1 ---
2 layout: default
3 navsection: userguide
4 title: "Checking your environment"
5 ...
6
7 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.
8
9 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:
10
11 <notextile>
12 <pre><code>$ <span class="userinput">arv user current</span>
13 {
14  "href":"https://qr1hi.arvadosapi.com/arvados/v1/users/qr1hi-xioed-9z2p3pn12yqdaem",
15  "kind":"arvados#user",
16  "etag":"8u0xwb9f3otb2xx9hto4wyo03",
17  "uuid":"qr1hi-tpzed-92d3kxnimy3d4e8",
18  "owner_uuid":"qr1hi-tpqed-23iddeohxta2r59",
19  "created_at":"2013-12-02T17:05:47Z",
20  "modified_by_client_uuid":"qr1hi-xxfg8-owxa2oa2s33jyej",
21  "modified_by_user_uuid":"qr1hi-tpqed-23iddeohxta2r59",
22  "modified_at":"2013-12-02T17:07:08Z",
23  "updated_at":"2013-12-05T19:51:08Z",
24  "email":"you@example.com",
25  "full_name":"Example User",
26  "first_name":"Example",
27  "last_name":"User",
28  "identity_url":"https://www.google.com/accounts/o8/id?id=AItOawnhlZr-pQ_Ic2f2W22XaO02oL3avJ322k1",
29  "is_active": true,
30  "is_admin": false,
31  "prefs":{}
32 }
33 </code></pre>
34 </notextile>
35
36 However, if you receive the following message:
37
38 bc. ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables
39
40 follow the instructions for "getting an API token,":{{site.baseurl}}/user/reference/api-tokens.html and try @arv user current@ again.