X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/5e9fbf33f20ecbc8584ca16f9e736763bc70e2e2..c91893eeff22e403bf29fb28f801d3b32d000947:/doc/user/getting_started/check-environment.textile diff --git a/doc/user/getting_started/check-environment.textile b/doc/user/getting_started/check-environment.textile index 192338f61e..c199db9871 100644 --- a/doc/user/getting_started/check-environment.textile +++ b/doc/user/getting_started/check-environment.textile @@ -7,17 +7,23 @@ navorder: 10 h1. Checking your environment +First you should "log into an Arvados VM instance":{{site.basedoc}}/user/getting_started/ssh-access.html#login if you have not already done so. + Check that you are able to access the Arvados API server using the following command: notextile.
$ arv user current
-If you receive the message "ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables", follow the instructions for "getting an API token,":{{site.basedoc}}/user/reference/api-tokens.html then return to this document. - -When @arv user current@ is able to access the API server, it will print out the unique identifier associated with your account. Here is an example (you will receive a different identifier): +If @arv user current@ is able to access the API server, it will print out the unique identifier associated with your account. Here is an example (you will receive a different identifier): bc. qr1hi-xioed-9z2p3pn12yqdaem -This unique identifier represents your identity in the Arvados system and is similar to the concept of a pointer or a foreign key. You may de-reference (get the contents of) any identifier returned by the "arv" command using the @-h@ command line option. For example: +However, if you receive the following message: + +bc. ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be defined as environment variables + +Then follow the instructions for "getting an API token,":{{site.basedoc}}/user/reference/api-tokens.html and return to this document. + +The unique identifier represents your identity in the Arvados system and is similar to the concept of a pointer or a foreign key. You may de-reference (get the contents of) any identifier returned by the "arv" command using the @-h@ command line option. For example:
$ arv -h user current
@@ -44,4 +50,4 @@ This unique identifier represents your identity in the Arvados system and is sim
 
-You are now ready proceed to the first tutorial: "Fetching data from Arvados using Keep.":{{site.basedoc}}/user/tutorials/intro-keep.html +You are now ready proceed to the first tutorial: "Storing and retrieving data using Arvados Keep.":{{site.basedoc}}/user/tutorials/tutorial-keep.html