wip

kcech · Oct 27, 2020 · e18837e · e18837e
1 parent 350330c
commit e18837e
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 26 deletions.
diff --git a/docs/api_docs.rst b/docs/api_docs.rst
@@ -8,6 +8,7 @@ Contents:
 
    api_docs/general_model
    api_docs/security
+   api_docs/rate_limiting
    api_docs/services
 
 The Application Programming Interface (API) of Sentilo defines a set of commands,

diff --git a/docs/api_docs/rate_limiting.rst b/docs/api_docs/rate_limiting.rst
@@ -0,0 +1,2 @@
+Rate Limiting
+=============
diff --git a/docs/api_docs/services/catalog/retrieve_authorized_entities.rst b/docs/api_docs/services/catalog/retrieve_authorized_entities.rst
@@ -252,4 +252,4 @@ Other examples
 
 .. note::
 
-   Only sensors will "online" state are return by the API.
+   Only sensors will "online" state are returned by the API.
diff --git a/docs/catalog_and_maps.rst b/docs/catalog_and_maps.rst
@@ -1050,7 +1050,7 @@ The main properties of the *Details* tab are the following:
 |                       |                       | value is online.            |
 +-----------------------+-----------------------+-----------------------------+
 | Substate              | Substate of the       | The list of possible        |
-|                       | sensor                | values that that have       |
+|                       | sensor                | values that have            |
 |                       |                       | informational purpose       |
 |                       |                       | and are specific for        |
 |                       |                       | every deployment. You       |
@@ -1063,9 +1063,9 @@ The main properties of the *Details* tab are the following:
 |                       |                       | mongoDB. No default         |
 |                       |                       | value.                      |
 +-----------------------+-----------------------+-----------------------------+
-| TTL (min)             | Time of expitation of | This value can be           |
-|                       | the sensor in minutes | configured only             |
-|                       |                       | from the catalog,           |
+| TTL (min)             | Time of expiration of | This value can be           |
+|                       | sensor's data in      | configured only             |
+|                       | minutes               | from the catalog,           |
 |                       |                       | Only admin should           |
 |                       |                       | control this value.         |
 |                       |                       | The default value is        |
@@ -1330,25 +1330,32 @@ select the item from the Alert Rule list and press Delete.
 Users
 ~~~~~
 
-Used for creating, updating or deleting console users. It’s possible to
-delete users massively through the elements list. There are three
-available roles:
+The "Users" section is for managing users of the catalog application. It’s possible to
+A catalog user can be one of these three roles:
 
 -  **Admin**: role for administration purposes.
 -  **Platform**: platform role for internal use.
 -  **User**: visualisation role, they could access to the administration
    console and read all the data, but they haven’t permission for
-   changing anything.
+   changing anything, except own contact details and password.
 
-**Properties**
+.. image:: _static/images/catalog_and_maps/users_170_001.jpg
+
+.. note::
+
+   A non-admin account will only see a menu "User" with his/her own details. A User role cannot see list other users.
+
+**User properties editable by administrator**
 
 +-----------------------+-----------------------+-----------------------+
 | Id                    | Name                  | Description           |
 +=======================+=======================+=======================+
 | Id                    | User identifier       | After its creation    |
 |                       |                       | can't be modified     |
 +-----------------------+-----------------------+-----------------------+
-| Password              | Password              |                       |
+| Password              | Password              | Admin user can        |
+|                       |                       | rewrite user's        |
+|                       |                       | password              |
 +-----------------------+-----------------------+-----------------------+
 | Repeat                | Password check        |                       |
 +-----------------------+-----------------------+-----------------------+
@@ -1370,15 +1377,19 @@ available roles:
 | Role                  | Related role          | Value list            |
 +-----------------------+-----------------------+-----------------------+
 
-.. _users-list:
 
-List
-^^^^
+.. _users-edit-a-user:
 
-.. image:: _static/images/catalog_and_maps/users_170_001.jpg
+Edit a User
+^^^^^^^^^^^
 
 .. image:: _static/images/catalog_and_maps/users_170_002.jpg
 
+
+.. note::
+
+   A password has to have 8-10 characters, and have at least 1 uppercase, 1 lowercase and 1 digit.
+
 Sensor types
 ~~~~~~~~~~~~
 

diff --git a/docs/use_a_virtual_machine.rst b/docs/use_a_virtual_machine.rst
@@ -5,7 +5,11 @@ A Sentilo sample instance is available for testing purposes distributed
 as a Open Virtual Appliance file
 (`OVA <https://en.wikipedia.org/wiki/Open_Virtualization_Format>`__).
 
-The appliance contains the **1.8.0 Sentilo release**.
+The appliance is available for download
+   `here <http://www.sentilo.io/wordpress/download/appliance/view(6).html>`__. It has been
+   tested with **Virtual Box v5.0.40**.
+
+The appliance contains the **1.9.0 Sentilo release** and runs Ubuntu Server 18.04.
 
 Components installed:
 
@@ -15,18 +19,11 @@ Components installed:
 -  Sentilo Alert Agent
 -  Sentilo Location Updater Agent
 
--  One designed for **Virtual Box**, available
-   `here <http://www.sentilo.io/wordpress/download/appliance/view(6).html>`__. It has been
-   tested using version **5.0.40**.
-
 The virtual machine credentials are **sentilo/sentilo**.
 
-After the virtual machine is started, all the sentilo services are
-launched automatically. The IP of the virtual machine is assigned
-automatically, to know which one is, enter into virtual machine and
-execute the **“ifconfig”** conmmand. In some settings you might need to
-port forward guest ports (essentially 8080 and 8081) and access them
-from your host machine.
+All sentilo services are started automatically. The IP of the virtual machine is assigned
+by the Virtualbox, to know which one is, enter the virtual machine and
+execute the **“ifconfig”** command. You'l probably need'.
 
 First steps: