X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c7bf82b621dae10a68a74b95439fa8f4ae3c502f..60418cbc557779898c50052af088f44f699ae157:/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 5cecd5100d..6afc20bf4f 100644 --- a/doc/user/reference/api-tokens.html.textile.liquid +++ b/doc/user/reference/api-tokens.html.textile.liquid @@ -3,23 +3,28 @@ 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. +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} -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.) +The Arvados API token is a secret key that enables the Arvados command line tools to authenticate themselves. -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). +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 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. +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. Setting the environment +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 *Current token*, which lists your current token and instructions to set up your environment. -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. +h2. Setting environment variables + +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. bc. HISTIGNORE=$HISTIGNORE:'export ARVADOS_API_TOKEN=*' export ARVADOS_API_TOKEN=2jv9346o396exampledonotuseexampledonotuseexes7j1ld export ARVADOS_API_HOST={{ site.arvados_api_host }} -export ARVADOS_API_HOST_INSECURE=true +unset ARVADOS_API_HOST_INSECURE * The @export@ command puts a local shell variable into the environment that will be inherited by child processes such as the @arv@ client.