X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/41c7c826a7e4c3a074a6ab5a719bf4c88e9a0e28..6870192ada3c34ffe5f0dc4c33ce2ad55bc2d263:/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 d47c1ccdae..4c27b603b9 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -1,61 +1,31 @@ --- 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.) - -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 ) . +Access the Arvados Workbench using this link: "{{site.arvados_workbench_host}}/":{{site.arvados_workbench_host}}/ (Replace the hostname portion with the hostname of your local Arvados instance if necessary.) -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. +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 "Webshell":{{site.baseurl}}/user/getting_started/vm-login-with-webshell.html or SSH (instructions for "Unix":{{site.baseurl}}/user/getting_started/ssh-access-unix.html#login or "Windows":{{site.baseurl}}/user/getting_started/ssh-access-windows.html#login). -h2. The easy way +In the Arvados Workbench, click on the dropdown menu icon in the upper right corner of the top navigation menu to access the user settings menu, and click on the menu item *My current token*, which lists your current token and instructions to set up your environment. -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: +h2. Setting environment variables -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, includes a command you may copy and paste directly into the shell. It will look something as the following. -* The @read@ command takes the contents of stdin and puts it into the shell variable named on the command line. -* The @< -
$ export ARVADOS_API_HOST={{ site.arvados_api_host }}
-$ export ARVADOS_API_TOKEN=2jv9346o3966345u7ueuim7a1zaaoueo3w90tzq3gx0es7j1ld
-
- - -* @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. - -If you are connecting to a development instance with a unverified/self-signed SSL certificate, set this variable to skip SSL validation: - - -
$ 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
@@ -65,7 +35,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