Advertise filters param in discovery doc.
[arvados.git] / doc / user / getting_started / check-environment.html.textile.liquid
1 ---
2 layout: default
3 navsection: userguide
4 navmenu: Getting Started
5 title: "Checking your environment"
6
7 ...
8
9 h1. Checking your environment
10
11 First you should "log into an Arvados VM instance":{{site.baseurl}}/user/getting_started/ssh-access.html#login if you have not already done so.
12
13 If @arv user current@ is able to access the API server, it will print out information about your account.  Check that you are able to access the Arvados API server using the following command:
14
15 <notextile>
16 <pre><code>$ <span class="userinput">arv user current</span>
17 {
18  "href":"https://qr1hi.arvadosapi.com/arvados/v1/users/qr1hi-xioed-9z2p3pn12yqdaem",
19  "kind":"arvados#user",
20  "etag":"8u0xwb9f3otb2xx9hto4wyo03",
21  "uuid":"qr1hi-tpzed-92d3kxnimy3d4e8",
22  "owner_uuid":"qr1hi-tpqed-23iddeohxta2r59",
23  "created_at":"2013-12-02T17:05:47Z",
24  "modified_by_client_uuid":"qr1hi-xxfg8-owxa2oa2s33jyej",
25  "modified_by_user_uuid":"qr1hi-tpqed-23iddeohxta2r59",
26  "modified_at":"2013-12-02T17:07:08Z",
27  "updated_at":"2013-12-05T19:51:08Z",
28  "email":"you@example.com",
29  "full_name":"Example User",
30  "first_name":"Example",
31  "last_name":"User",
32  "identity_url":"https://www.google.com/accounts/o8/id?id=AItOawnhlZr-pQ_Ic2f2W22XaO02oL3avJ322k1",
33  "is_active": true,
34  "is_admin": false,
35  "prefs":{}
36 }
37 </code></pre>
38 </notextile>
39
40 However, if you receive the following message:
41
42 bc. ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables
43
44 Then follow the instructions for "getting an API token,":{{site.baseurl}}/user/reference/api-tokens.html and try @arv user current@ again.
45
46 Once you are able to access the API server, you are ready proceed to the first tutorial: "Storing and retrieving data using Arvados Keep.":{{site.baseurl}}/user/tutorials/tutorial-keep.html