aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNeil Williams <neil.williams@linaro.org>2018-09-12 12:16:57 +0100
committerRĂ©mi Duraffort <remi.duraffort@linaro.org>2018-09-12 11:22:38 +0000
commit6ff5b43b4a93c4646fb790687f32a6d6e628206b (patch)
tree017aac869be144208848a0a73a73cf90290612ea /doc
parent002340a3ab4eebeaf39f9aa1e872cd2b154c27e3 (diff)
Clarify some of the lavacli doc items
Provide a link back to how to create a token and a note on http:// or https:// Signed-off-by: Neil Williams <neil.williams@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/v2/lavacli.rst15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/v2/lavacli.rst b/doc/v2/lavacli.rst
index c7303b013..adf9cc1fd 100644
--- a/doc/v2/lavacli.rst
+++ b/doc/v2/lavacli.rst
@@ -64,13 +64,18 @@ on which the user has an account.::
$ sudo apt install lavacli
(If you are installing on Debian Stretch, you will need to first enable
-``backports`` to install ``lavacli``).
+``backports`` to install ``lavacli``) and tell ``apt`` to use
+``stretch-backports``::
+
+ $ sudo apt -t stretch-backports install lavacli
.. _using_lavacli:
Using lavacli
*************
+.. seealso:: :ref:`Creating & displaying a token <authentication_tokens>`
+
Once the token is created, add it to the configuration of lavacli.
Click on the "Display the token" link on the "Authentication Tokens"
page and copy the token. e.g. if your token was created on
@@ -78,10 +83,18 @@ validation.linaro.org then you may want to use the identity
``production``. The ``uri`` is typically provided on the *Available
methods* page, e.g. ``http://localhost/api/help``.
+Run ``lavacli`` as your normal username. Avoid using ``sudo``.
+
The syntax is::
--token <TOKEN> --uri <URI> --username <USERNAME> <IDENTITY>
+(``<TOKEN>`` is the displayed Authentication Token string)
+
+ .. note:: You should configure and use ``https://`` for all
+ **public** instances. Only use ``http://`` for localhost or
+ developer instances.
+
.. code-block:: none
$ lavacli identities add --token <TOKEN> --uri https://validation.linaro.org/RPC2 --username <USERNAME> production