X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/cf7e30873ef4b92cc8ec099b2bb344391a070e93..4a919918a4ce37b5290793f02fa959db1c073590:/doc/user/reference/api-tokens.html.textile.liquid diff --git a/doc/user/reference/api-tokens.html.textile.liquid b/doc/user/reference/api-tokens.html.textile.liquid index 018c71c678..d5172f0c5b 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -3,55 +3,34 @@ layout: default navsection: userguide title: "Getting an API token" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. -The Arvados API token is a secret key that enables the @arv@ command line client to access Arvados with the proper permissions. - -Access the Arvados workbench using this link: "https://{{ site.arvados_workbench_host }}/":https://{{ site.arvados_workbench_host }}/ - -(Replace @{{ site.arvados_api_host }}@ with the hostname of your local Arvados instance if necessary.) - -First, open a shell on the system on which you intend to use the Arvados client (this may be your local workstation, or an Arvados VM, refer to "Accessing Arvados over ssh":{{site.baseurl}}/user/getting_started/ssh-access.html ) . - -Click on the user icon in the upper right corner to access the user settings menu, and click on the menu item _Manage API token_ to go to the "api client authorizations" page. - -h2. The easy way - -For your convenience, the "api client authorizations" page on Workbench provides a "Help" tab that provides a command you may copy and paste directly into the shell. It will look something like this: +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -bc. ### Pasting the following lines at a shell prompt will allow Arvados SDKs -### to authenticate to your account, youraddress@example.com -read ARVADOS_API_TOKEN < in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *Current token*, which lists your current token and instructions to set up your environment. - -
$ export ARVADOS_API_HOST={{ site.arvados_api_host }}
-$ export ARVADOS_API_TOKEN=2jv9346o3966345u7ueuim7a1zaaoueo3w90tzq3gx0es7j1ld
-
-
+h2. Setting environment variables -* @ARVADOS_API_HOST@ tells @arv@ which host to connect to -* @ARVADOS_API_TOKEN@ is the secret key used by the Arvados API server to authenticate access. +The *Current token* page, accessed using the dropdown menu icon in the upper right corner of the top navigation menu, includes a command you may copy and paste directly into the shell. It will look something as the following. -If you are connecting to a development instance with a unverified/self-signed SSL certificate, set this variable to skip SSL validation: +bc. HISTIGNORE=$HISTIGNORE:'export ARVADOS_API_TOKEN=*' +export ARVADOS_API_TOKEN=2jv9346o396exampledonotuseexampledonotuseexes7j1ld +export ARVADOS_API_HOST={{ site.arvados_api_host }} +unset ARVADOS_API_HOST_INSECURE - -
$ export ARVADOS_API_HOST_INSECURE=1
-
-
+* The @export@ command puts a local shell variable into the environment that will be inherited by child processes such as the @arv@ client. h2. settings.conf -Arvados tools will also look for the authentication information in @~/.config/arvados/settings.conf@. If you have already put the variables into the environment with instructions above, you can use these commands to create an Arvados configuration file: +Arvados tools will also look for the authentication information in @~/.config/arvados/settings.conf@. If you have already put the variables into the environment following the instructions above, you can use these commands to create an Arvados configuration file:
$ echo "ARVADOS_API_HOST=$ARVADOS_API_HOST" > ~/.config/arvados/settings.conf
@@ -61,7 +40,7 @@ $ echo "ARVADOS_API_TOKEN=$ARVADOS_API_TOKEN" >> ~/.conf
 
 h2. .bashrc
 
-Alternately, you may add the declarations of @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ to the @~/.bashrc@ file on the system on which you intend to use the Arvados client.  If you have already put the variables into the environment with instructions above, you can use these commands to append the environment variables to your @~/.bashrc@:
+Alternately, you may add the declarations of @ARVADOS_API_HOST@ and @ARVADOS_API_TOKEN@ to the @~/.bashrc@ file on the system on which you intend to use the Arvados client.  If you have already put the variables into the environment following the instructions above, you can use these commands to append the environment variables to your @~/.bashrc@:
 
 
 
$ echo "export ARVADOS_API_HOST=$ARVADOS_API_HOST" >> ~/.bashrc