Commit 67537b9a authored by Etienne Allovon's avatar Etienne Allovon
Browse files

Add documentation for autolog with token and enhance config ini file doc

parent 7d80a42e
......@@ -15,6 +15,10 @@ Below is a list of *New Features* and *Behavior Changes* compared to the previou
New Features
------------
* Desktop Assistant:
* INI file to pre-configure the assistant - see :ref:`dapp_inifile`.
* Autolog a user with his token - see :ref:`dapp_autolog_wtoken`.
* CC Agent:
* Manage the activity's failed destination: can display the destination and change it to a sound or a default queue - see :ref:`agent_activity_failed_dst`.
......
......@@ -98,21 +98,43 @@ It is supported on both Windows and Linux Debian based distributions (with a des
.. _Freedesktop: https://www.freedesktop.org/wiki/
.. _desktop_assistant_inifile:
.. _dapp_inifile:
Config file
-----------
You can specify your Desktop Assistant parameters by providing a **xivoconfig.ini** file or by editing the one that gets created automatically
You can specify your Desktop Assistant parameters by providing a :file:`xivoconfig.ini` file or by editing the one that gets created automatically
on first launch. This file **must be located in the same folder as your Desktop Assistant executable**.
The xivoconfig.ini file template is as follows :
Below is an example of the file:`xivoconfig.ini` file content:
* **APP_PROTOCOL= HTTPS** (by default) or **HTTP** (*Defines if the connection is secured or not*)
* **APP_SERVER= URL** or **IP:PORT** (*Defines the server used by the Desktop Assistant*)
* **APP_INTERFACE= UCASSISTANT** or **CCAGENT** (*Defines which interface will be opened on startup*)
* **APP_STARTUP= true** or **false** (*Defines if the UC assistant opens on operating system startup*)
* **APP_CLOSE= true** or **false** (*Defines if the UC assistant will be minimized in the taskbar instead of closed*)
.. code-block:: ini
APP_PROTOCOL=HTTPS
APP_SERVER=xivo.mycorp.com
APP_INTERFACE=UCASSISTANT
APP_STARTUP=false
APP_CLOSE=true
APP_PROTOCOL
Define the use of HTTPS or HTTP connection.
Values: ``HTTP`` or ``HTTPS`` (default to ``HTTPS``)
APP_SERVER
The server used by the Desktop Assistant.
Either an URL (e.g. xivo.mycorp.com) or an IP:PORT (e.g. 192.168.0.1:8070)
APP_INTERFACE
Which application to open between UC Assistant or CC Agent.
Values: ``UCASSISTANT`` or ``CCAGENT``
APP_STARTUP (optional)
Enable open at startup of OS.
Values: ``true`` or ``false``
APP_CLOSE (optional)
Enable minimization in the taskbar when closing the application.
Values: ``true`` or ``false``
Update
......@@ -139,10 +161,25 @@ The Desktop Application can be started with following options:
* ``--ignore-certificate-errors`` to disable certificate verification, this option is meant **only** for test purposes. You can use it with self-signed certificates.
* ``-d`` to enable debug menu items
* ``-t`` with an authentication token as parameter (see :ref:`dapp_autolog_wtoken`)
.. note:: On **Windows** both options must be set to the shortcut ``xivo-desktop-assistant.exe`` pointing to application located in ``C:\Users\<USER>\AppData\Local\xivo\xivo-desktop-assistant.exe`` so that **Target** of shortcut looks like for example to:
``C:\Users\IEUser\AppData\Local\xivo\xivo-desktop-assistant.exe --ignore-certificate-errors -d``
.. _dapp_autolog_wtoken:
Autologin with a token
----------------------
You can autolog an user using his user token.
Pre-requisites:
#. Create a :file:`xivoconfig.ini` file - see :ref:`dapp_inifile` - with at least the ``APP_PROTOCOL``, ``APP_SERVER`` and ``APP_INTERFACE`` parameters
#. Retrieve the user token (you can retrieve it using curl - see :ref:`rest_authentication`)
When you have the token, you can pass it to the :program:`xivo-desktop-assistant` exe using arg ``-t YOUR_TOKEN``
Custom user data directory
--------------------------
......
......@@ -18,12 +18,3 @@ minimalist view and default one.
.. figure:: bar.png
:scale: 100%
UC Assistant
=============
Log in with a token
-------------------
You can auto-login an user using his user token, which you can retrieve using curl. See :ref:`rest_authentication`
When you have the token, you can pass it as a launch argument using -t YOUR_TOKEN
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment