X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/430d4da65c609d1fde6e3cd428e7591b58cfd9e9..01d0323bec359b6e52705163f55a847ce494dc29:/doc/user/reference/api-tokens.html.textile.liquid?ds=sidebyside diff --git a/doc/user/reference/api-tokens.html.textile.liquid b/doc/user/reference/api-tokens.html.textile.liquid index 4c49d4ae88..4bb1e81673 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -1,41 +1,32 @@ --- layout: default navsection: userguide -navmenu: Reference title: "Getting an API token" - ... -h1. Reference: Getting an API token - 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://workbench.{{ site.arvados_api_host }}/":https://workbench.{{ site.arvados_api_host }}/ - -(Replace @{{ site.arvados_api_host }}@ with the hostname of your local Arvados instance if necessary.) +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.basedoc}}/user/getting_started/ssh-access.html ) . +Open a shell on the system where you want to use the Arvados client. This may be your local workstation, or an Arvados virtual machine accessed with SSH ("Unix":{{site.baseurl}}/user/getting_started/ssh-access-unix.html#login or "Windows":{{site.baseurl}}/user/getting_started/ssh-access-windows.html#login). -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. +Click on the link with your _email address_ in the upper right corner to access the user settings menu, and click on the menu item *Manage account* to go to the account management page. On the *Manage account* page, you will see the *Current Token* panel, which lists your current token and instructions to setup your environment. 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: +For your convenience, the "Manage account" page on Workbench provides the "Current Token" panel that includes a command you may copy and paste directly into the shell. It will look something like this: -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 <
$ export ARVADOS_API_HOST={{ site.arvados_api_host }}
@@ -43,8 +34,8 @@ $ export ARVADOS_API_TOKEN=2jv9346o3966345u7ueuim7a1zaao
 
-* @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. +* @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. Its value is the text you copied from the *api_token* column on the Workbench. If you are connecting to a development instance with a unverified/self-signed SSL certificate, set this variable to skip SSL validation: @@ -55,7 +46,7 @@ If you are connecting to a development instance with a unverified/self-signed SS 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
@@ -65,7 +56,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