X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/715869b9a22e22ac68a7dbefa96f27150017f75d..6fb5d2bd10901a1e0ced4ea8849419145d47a0b5:/doc/user/getting_started/check-environment.html.textile.liquid diff --git a/doc/user/getting_started/check-environment.html.textile.liquid b/doc/user/getting_started/check-environment.html.textile.liquid index ac3d90cbf8..2908e6e742 100644 --- a/doc/user/getting_started/check-environment.html.textile.liquid +++ b/doc/user/getting_started/check-environment.html.textile.liquid @@ -1,33 +1,15 @@ --- layout: default navsection: userguide -navmenu: Getting Started title: "Checking your environment" - ... -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
+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. -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 - -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: +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: -
$ arv -h user current
+
$ arv user current
 {
  "href":"https://qr1hi.arvadosapi.com/arvados/v1/users/qr1hi-xioed-9z2p3pn12yqdaem",
  "kind":"arvados#user",
@@ -51,4 +33,8 @@ The unique identifier represents your identity in the Arvados system and is simi
 
-You are now ready proceed to the first tutorial: "Storing and retrieving data using Arvados Keep.":{{site.basedoc}}/user/tutorials/tutorial-keep.html +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.baseurl}}/user/reference/api-tokens.html and try @arv user current@ again.