Commit 9e6ee2da authored by Etienne Allovon's avatar Etienne Allovon

Merge branch 'Aldebaran.03' into 2018.05

parents 181e6c09 6ce9cf53
......@@ -20,7 +20,7 @@ endif
envs/bin/sphinx-build:
python2.7 -mvirtualenv --system-site-packages envs
envs/bin/python envs/bin/pip install -U --cache-dir .cache/pip -I Pygments==2.2.0 setuptools==28.8.0 docutils==0.13.1 mock==1.0.1 pillow==2.6.1 "alabaster>=0.7,<0.8,!=0.7.5" commonmark==0.5.4 recommonmark==0.4.0 sphinx==1.5.3 "sphinx-rtd-theme<0.3" "readthedocs-sphinx-ext<0.6"
envs/bin/python envs/bin/pip install -U --cache-dir .cache/pip -I Pygments==2.2.0 "setuptools<41" docutils==0.13.1 mock==1.0.1 pillow==2.6.1 "alabaster>=0.7,<0.8,!=0.7.5" commonmark==0.5.4 recommonmark==0.4.0 sphinx==1.7.4 "sphinx-rtd-theme<0.3" "readthedocs-sphinx-ext<0.6"
envs/bin/python envs/bin/pip install --exists-action=w --cache-dir .cache/pip -rrequirements.txt
......
git+https://gitlab.com/xivo.solutions/sphinx-git.git@tagtitles
gitpython
sphinx_rtd_theme
......@@ -5,6 +5,10 @@ Proxy Configuration
If you use XiVO behind an HTTP proxy, you must do a couple of manipulations for
it to work correctly.
.. warning:: We do not recomend to use ``http_proxy`` environment variable. It may
break some services.
Instead you should configure the proxy on a per service basis as described
below.
apt
===
......@@ -14,6 +18,24 @@ Create the :file:`/etc/apt/apt.conf.d/90proxy` file with the following content::
Acquire::http::Proxy "http://domain\username:password@proxyip:proxyport";
dhcp-update
===========
*This step is needed if you use the DHCP server of the XiVO. Otherwise the DHCP configuration won't be correct.*
Proxy information is set via the :file:`/etc/xivo/dhcpd-update.conf` file.
Edit the file and look for the ``[proxy]`` section.
docker
======
When upgrading or installing XiVO it will attempt to download docker images.
For the proxy configuration, you need to create a systemd configuration file.
See Docker documentation: https://docs.docker.com/config/daemon/systemd/#httphttps-proxy
provd
=====
......@@ -21,14 +43,15 @@ Proxy information is set via the :menuselection:`Configuration --> Provisioning
page.
dhcp-update
===========
wget
====
*This step is needed if you use the DHCP server of the XiVO. Otherwise the DHCP configuration won't be correct.*
*This step is needed because this tool is used by xivo-upgrade script.*
Proxy information is set via the :file:`/etc/xivo/dhcpd-update.conf` file.
Create the :file:`~/.wgetrc` file with the following content::
Edit the file and look for the ``[proxy]`` section.
use_proxy=yes
http_proxy=http://username:password@proxyip:proxyport
xivo-fetchfw
......
......@@ -230,6 +230,58 @@ For Firefox:
- add domain (without protocol) to the ``network.negotiate-auth.delegation-uris`` entry (ie. ``xuc.mydomain``).
- add domain (without protocol) to the ``network.negotiate-auth.trusted-uris`` entry (ie. ``xuc.mydomain``).
.. _cas-sso-configuration:
CAS SSO Authentication
=======================
To enable CAS authentication and single sign on feature, you need to have an existing CAS infrastructure. You need to be able to create a service for the XiVOCC environment.
.. warning::
The CAS authentication server must be accessible from the user and the server hosting the XiVOCC containers.
CAS Server users' username must match the XiVO username to allow login on the XiVOCC applications.
XiVOCC Configuration
--------------------
* Edit the docker compose file ``/etc/docker/compose/docker-xivocc.yml`` to add the following configuration in the xuc section (use your CAS server URL instead of ``https://cas-server.example.org/cas``):
.. code-block:: dockerfile
xucmgt:
# ...
environment:
- CAS_SERVER_URL=https://cas-server.example.org/cas
- ...
# ...
xuc:
# ...
environment:
- CAS_SERVER_URL=https://cas-server.example.org/cas
- ...
# ...
* Enable ``Single Sign On`` on the Agent, Manager, Web and Desktop application interface. Change the value of the following environment variables in the `/etc/docker/compose/custom.env`:
.. code-block:: ini
# ...
USE_SSO=true
XUC_HOST=xuc.mydomain
# ...
* Recreate and start the XiVOCC environment:
.. code-block:: shell
xivocc-dcomp up -d
.. _nginx-trusted-certificate:
Install trusted certificate for nginx
......
......@@ -99,6 +99,44 @@ where error_code is one of:
This token can then be used with the :ref:`CTI Authentication <cti_authentication>` and :ref:`rest_authentication_check`.
Obtain authentication token (SSO/CAS)
==========================================
GET http://localhost:$xucport/xuc/api/2.0/auth/cas?service=https://xucmgt.example.org&ticket=ST-11-Qsicgrh1mZ3dgoeOx7m6-af27d9025e0c
::
curl -XGET http://localhost:8090/xuc/api/2.0/auth/cas?service=https://xucmgt.example.org&ticket=ST-11-Qsicgrh1mZ3dgoeOx7m6-af27d9025e0c
Will retrieve an object
::
{login: "<login>", token: "<token>"}
or an error
::
{error:"<error_code>", message:"<error_message>"}
where error_code is one of:
* UserNotFound: User was authenticated using SSO but the corresponding user does not exist on XiVO
* CasServerUrlNotSet: XiVOCC containers are not configured (see :ref:`CAS SSO Authentication <cas-sso-configuration>`)
* CasServerInvalidResponse: The CAS server returned an invalid response
* CasServerInvalidParameter: The Parameters sent to the CAS Server are invalid
* CasServerInvalidRequest: The Request to the CAS server is invalid
* CasServerInvalidTicketSpec: The ticket specification is invalid
* CasServerUnauthorizedServiceProxy: The CAS service proxy is not authorized
* CasServerInvalidProxyCallback: The CAS service proxy callback is invalid
* CasServerInvalidTicket: The ticket is invalid (probably expired or defined for another service)
* CasServerInvalidService: The service is invalid
* CasServerInternalError: CAS Server internal error
* UnhandledError
This token can then be used with the :ref:`CTI Authentication <cti_authentication>` and :ref:`rest_authentication_check`.
.. _rest_authentication_check:
Check authentication token
......
......@@ -43,7 +43,7 @@ import os
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.todo', 'sphinx_git', 'sphinx.ext.graphviz']
extensions = ['sphinx.ext.todo', 'sphinx.ext.graphviz']
graphviz_output_format = 'svg'
# Add any paths that contain templates here, relative to this directory.
......
......@@ -52,16 +52,21 @@ and both queues (name and number) under column **File** in one recording.
Stop recording upon external transfer
-------------------------------------
Recording is stopped when both parties of the call are external.
Recording is stopped when an incoming call is transferred to an external number:
For example if an external incoming call is recorded and if, at some point, it is transferred to an external party,
as soon as the transfer is completed, the recording of the incoming call will be stopped.
In the same way if an internal user makes an outgoing call which is recorded and then transfers it to another external party,
as soon as the transfer is completed, the recording of the outgoing call will be stopped.
* Given a **external incoming call** which is **recorded**,
* If this call is transferred to an external number (via the phone or the UC Assistant or the CC Agent),
* Then, as soon as the transfer is completed, the recording of the **incoming call** will be stopped.
This behavior can be deactivated, see :ref:`configuration section <stop_recording_upon_ext_xfer_conf>`.
.. note:: **Limitations:**
Note that this feature is not intended to work if outgoing calls are recorded. In this case:
* if an external incoming call is transferred to an external number, only the incoming call recording will be stopped. The outgoing call recording won't be stopped.
* if an outgoing call is transferred to another outgoing call, the recording won't be stopped.
Recording filtering
===================
......
......@@ -22,8 +22,8 @@ Installing from the ISO image
.. note:: Our ISO image does not support UEFI system
* Download the ISO image. (`latest version`_) (`all versions`_)
* Boot from the ISO image, select ``Install`` and follow the instructions. You must select a locale
with charset UTF-8.
* Boot from the ISO image, select ``Install`` and follow the instructions. You must select locale
``en_US.UTF-8``.
* At the end of the installation, you can continue by running the :ref:`configuration
wizard. <configuration_wizard>`
......@@ -39,10 +39,10 @@ Otherwise GPG key of XiVO repository will not be installed and must be added man
Installing from a minimal Debian installation
=============================================
XiVO can be installed directly over a **64-bit** Debian jessie. When doing so, you are strongly
advised to start with a clean and minimal installation of Debian jessie.
XiVO can be installed directly over a **64-bit** Debian **Jessie**. When doing so, you are strongly
advised to start with a clean and minimal installation of Debian **Jessie**.
The latest installation image for Debian jessie can be found at https://www.debian.org/releases/jessie/debian-installer.
The latest installation image for Debian **Jessie** can be found at https://www.debian.org/releases/jessie/debian-installer.
Requirements
......@@ -51,7 +51,7 @@ Requirements
The installed Debian must:
* use the architecture ``amd64``
* have a default locale with charset UTF-8
* have a default locale ``en_US.UTF-8``
.. note:: In case you want to migrate a XiVO from ``i386`` to ``amd64``, see :ref:`migrate_i386_to_amd64`.
......
......@@ -131,6 +131,19 @@ will not be accessible through this incoming call.
has no password.
E-mail notification
===================
E-mail message can be configured to be sent to user of the voicemail :
* configure mail server in :menuselection:`Configuration --> Network --> Mail`
* set e-mail address of the user in configuration of his voicemail
Default message can be set in :menuselection:`Services --> IBX --> General Settings --> Voicemails` and it can be customized
from tab E-mail in :menuselection:`Services --> IBX --> IPBX settings --> Voicemails`.
Letters ``;`` and ``\`` must be preceded with backslash and ``,`` (comma) can be written only in the default message.
Advanced configuration
======================
......
......@@ -10,7 +10,7 @@ Aldebaran (2018.LTS3)
+----------------------+----------------+
| Component | latest ver. |
+======================+================+
| config-mgt | 2018.05.02 |
| config-mgt | 2018.05.03 |
+----------------------+----------------+
| elasticsearch | 1.7.2 |
+----------------------+----------------+
......@@ -26,7 +26,7 @@ Aldebaran (2018.LTS3)
+----------------------+----------------+
| recording-rsync | 1.0 |
+----------------------+----------------+
| recording-server | 2018.05.02 |
| recording-server | 2018.05.03 |
+----------------------+----------------+
| spagobi | 2018.05.00 |
+----------------------+----------------+
......@@ -34,13 +34,87 @@ Aldebaran (2018.LTS3)
+----------------------+----------------+
| xivo-full-stats | 2018.05.00 |
+----------------------+----------------+
| XiVO PBX | 2018.05.02 |
| XiVO PBX | 2018.05.03 |
+----------------------+----------------+
| xuc | 2018.05.02 |
| xuc | 2018.05.04 |
+----------------------+----------------+
| xucmgt | 2018.05.02 |
| xucmgt | 2018.05.03 |
+----------------------+----------------+
Aldebaran.04
------------
.. note:: Bugfix release. See :ref:`aldebaran_release` section for features list and behavior changes.
Consult the `Aldebaran.04 Roadmap <https://projects.xivo.solutions/versions/99>`_.
Components updated: **xucserver**
**XUC Server**
* `#1905 <https://projects.xivo.solutions/issues/1905>`_ - Can't download callback tickets in ccmanager
Aldebaran.03
------------
.. note:: Bugfix release. See :ref:`aldebaran_release` section for features list and behavior changes.
Consult the `Aldebaran.03 Roadmap <https://projects.xivo.solutions/versions/93>`_.
Components updated: **config-mgt**, **recording-server**, **xivo-dao**, **xivo-install-cd**, **xivo-manage-db**, **xivo-web-interface**, **xucmgt**, **xucserver**
**CCManager**
* `#1770 <https://projects.xivo.solutions/issues/1770>`_ - Rename statistic "Divert." on ccmanager(queue_view)
.. important:: **Behavior change** In CC Manager, in view Queues, column "Divert." was renamed to "Timeout".
* `#1887 <https://projects.xivo.solutions/issues/1887>`_ - Call qualification export should be completely in JSON
**Config mgt**
* `#1847 <https://projects.xivo.solutions/issues/1847>`_ - Use Config Mgt with HTTPS protocol
* `#1857 <https://projects.xivo.solutions/issues/1857>`_ - configmgt redirection to login is not working
* `#1892 <https://projects.xivo.solutions/issues/1892>`_ - Cannot give the role Teacher to an user in configmgt
**Recording**
* `#1860 <https://projects.xivo.solutions/issues/1860>`_ - Outgoing transfer doesn't have the correct recording audio file link in list of recorded files
* `#1884 <https://projects.xivo.solutions/issues/1884>`_ - Ordering of agents and queues in description of a transfered call recording
**XUC Server**
* `#1853 <https://projects.xivo.solutions/issues/1853>`_ - XuC user right is not using correct url for configmgt
* `#1867 <https://projects.xivo.solutions/issues/1867>`_ - High memory & cpu usage triggered by call loops and outbound queue calls
* `#1872 <https://projects.xivo.solutions/issues/1872>`_ - Document limitation for stop recording upon external xfer feature
* `#1901 <https://projects.xivo.solutions/issues/1901>`_ - Disable AMI log in xucserver
**XiVO PBX**
* `#569 <https://projects.xivo.solutions/issues/569>`_ - Voicemail Email - For a given voicemail, customizing email body doesn't accept some "ponctuation" characters
.. important:: **Behavior change** Some new error messages in XiVO web interface are displayed in the default language of web browser. The language can be different.
* `#1749 <https://projects.xivo.solutions/issues/1749>`_ - Support CAS with SSO
.. note:: See :ref:`CAS SSO Authentication Configuration <cas-sso-configuration>`
* `#1760 <https://projects.xivo.solutions/issues/1760>`_ - XiVO installation from ISO creates slow LVM partition
* `#1782 <https://projects.xivo.solutions/issues/1782>`_ - Outgoing caller id and call permissions have wrong user id when unc. fwd
* `#1785 <https://projects.xivo.solutions/issues/1785>`_ - Destination list hidden when creating a func key with boss-secretary filter
* `#1810 <https://projects.xivo.solutions/issues/1810>`_ - Qualifications table not created on fresh xivo install
* `#1865 <https://projects.xivo.solutions/issues/1865>`_ - Web interface doesn't indicate that system configuration must be applied
* `#1894 <https://projects.xivo.solutions/issues/1894>`_ - Button for mass synchronization disappears from web interface
* `#1897 <https://projects.xivo.solutions/issues/1897>`_ - Doc - Live reload deactivation implications
.. note:: See new table in :ref:`General settings <adv_general_settings>` section.
**XiVOCC Infra**
* `#1497 <https://projects.xivo.solutions/issues/1497>`_ - Simplify ISO build
Aldebaran.02
------------
......
Markdown is supported
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