X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/b91db14a4dced9d6ea124e86be3c796e6f2c8e8c..30c1cff48b0cb14e28a8b5d77b78029997c8521a:/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 317e7a026d..5cecd5100d 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -8,44 +8,21 @@ The Arvados API token is a secret key that enables the @arv@ command line client 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.) -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":{{site.baseurl}}/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 (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). -Click on the user icon in the upper right corner to access the user settings menu. Click on the menu item *Manage API tokens* 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 +h2. Setting the environment -For your convenience, the "Api client authorizations" page on Workbench provides a *Help* tab that includes 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 as the following. -bc. ### Pasting the following lines at a shell prompt will allow Arvados SDKs -### to authenticate to your account, you@example.com -read ARVADOS_API_TOKEN < -
$ 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. 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: - - -
$ export ARVADOS_API_HOST_INSECURE=1
-
-
- 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 following the instructions above, you can use these commands to create an Arvados configuration file: