Upgrade notes

18.05

  • xivo-dird has been renamed wazo-dird
    • The custom configuration has been moved to /etc/wazo-dird/conf.d/.
    • The log file has been renamed to wazo-dird.log.
    • The NGINX proxy has been recreated in /etc/nginx/locations/https-enabled/wazo-dird
    • Entrypoint for custom plugin has been renamed to wazo_dird.*. See Integration of wazo-dird with the rest of Wazo.
  • xivo-dird-client has been renamed wazo-dird-client
    • If you were using the xivo-dird-client in your python code you should use the wazo-dird-client which has the same interface at the moment.
  • wazo-dird now uses a token to authenticate when doing searches on xivo-confd
    • See xivo if you have customized configuration files in /etc/wazo-dird/sources.d or /etc/wazo-dird/conf.d for a source of type xivo
    • If you are using custom certificates you will have to modify your directory configuration to add your certificate. See Certificates for HTTPS for more information in the Use your own certificate section.
  • Authentication policies now have a tenant_uuid and the relationship between tenants and policies has been removed. If you did use policies with tenant association, the policy is now associated to one of its tenant. This feature is not used yet in Wazo, so most likely you are not affected.

18.04

  • Invalid user email will be deleted automatically during upgrade.
  • Asterisk configuration files can now be customized in the /etc/asterisk/*.d/ directories. If you had custom configuration in /etc/asterisk/*.conf you will have to create a new file in the corresponding .d directory to use your customized configuration. Files named *.conf.dpkg-old will be left in /etc/asterisk if this operation is required. See Asterisk configuration files for more details.
  • The user authentication has been updated with the following impacts:
    • User’s password cannot be returned in plain text anymore.
    • Users export (export CSV) cannot export password anymore.
    • Time to import users (import CSV) has been increased significatively if the field password is provided.
    • Fields username and password in xivo-confd API /users don’t have impact anymore on authentication and must be considered as invalid. To change these values, use wazo-auth API instead.
    • Fields enabled for xivo-confd API /users/<user_id>/cti don’t have impact anymore on authentication and must be considered as invalid. To change this value, use wazo-auth API instead.
    • In wazo-auth, the backend xivo_user has been removed.
    • In xivo-ctid, the default authentication backend is now wazo_user.
  • Default phone passwords are now auto-generated. Switchboard users with a Snom device will now have to add a configuration file to store the username and password. See Snom Phones
  • Creating user using the REST API now requires the Wazo-Tenant HTTP header when the created user is not in the same tenant has its creator.
  • Tenants have automatically created to match configured entities.

18.03

  • If you have a custom certificate configured, you will need to add a new symlink for wazo-upgrade:

    mkdir -p /etc/wazo-upgrade/conf.d
    ln -s "/etc/xivo/custom/custom-certificate.yml" "/etc/wazo-upgrade/conf.d/010-custom-certificate.yml"
    
  • Default passwords for phones’ web interfaces have been changed. You can change the password in Configuration ‣ Provisioning ‣ Template device.

  • The default NAT option in General SIP settings has been automatically changed from auto_force_rport to auto_force_rport,auto_comedia. This makes NAT configuration easier but has no impact on environments without NAT.

    • In the rare cases where you want to keep nat=auto_force_rport you must explicitly change this value in the administation interface Services ‣ IPBX ‣ General Settings ‣ SIP Protocol in tab Default. See Asterisk sip.conf sample for more informations.
  • The NAT configuration of every SIP line and SIP trunk has been automatically changed from nat=auto_force_rport to nothing, so that they inherit this setting from the General SIP settings.

Consult the 18.03 Roadmap for more information.

18.02

  • For wazo-auth backend developers: The API to implement a wazo-auth backend has changed. Old implementations have to be updated. If the BaseAuthenticationBackend class was used as a base class for the backend the get_metadata method from the base class will use get_ids to generate the result of get_metadata.
    • The get_ids method has been remove.
    • The get_metadata method has been added.

Consult the 18.02 Roadmap for more information.

18.01

  • Debian has been upgraded from version 8 (jessie) to 9 (stretch). Please consult the following detailed upgrade notes for more information:
  • If you did not setup a custom X.509 certificate for HTTPS (e.g. from Let’s Encrypt), the certificate will be regenerated to include SubjectAltName fields. The two main reasons are Chrome compatibility and avoiding a lot of log warnings. This implies that you will have to add a new exception in your browser to access the Wazo web interface or services like Unicom.

  • If you did setup a custom X.509 certificate for HTTPS (e.g. from Let’s Encrypt), you will have to add a link to the wazo-auth-cli configuration using the following command.

    ln -s "/etc/xivo/custom/custom-certificate.yml" "/etc/wazo-auth-cli/conf.d/010-custom-certificate.yml"
    
  • The Python API for xivo-confd plugins has been updated to reflect Python API of other daemons. If you have created a custom xivo-confd plugin, you must update it:

    plugin.old.py
    class Plugin(object):
    
       def load(self, core):
           api = core.api
           config = core.config
    
    plugin.py
    class Plugin(object):
    
       def load(self, dependencies):
           api = dependencies['api']
           config = dependencies['config']
    
  • The web interface no longer validates the queue skill rules fields added in Services ‣ Call Center ‣ Configuration ‣ Skill rules. If a rule is wrong, it will appear in the Asterisk console.

Consult the 18.01 Roadmap for more information.

17.17

  • The default NAT option has changed from no to auto_force_rport. This makes NAT configuration easier but has no impact on environments without NAT.

    • In the rare cases where you want to keep nat=no you must explicitly change this value in the administation interface Services ‣ IPBX ‣ General Settings ‣ SIP Protocol in tab Default. See Asterisk sip.conf sample for more informations.
  • The sources section of the xivo-dird service configuration has been changed to be a key-value setting.

    • If you have configured directories manually in /etc/xivo-dird you should update your manual configuration:
    old.yml
    services:
      lookup:
        default:
          sources:
            - source_one
            - source_two
          timeout: 2
    
    new.yml
    services:
      lookup:
        default:
          sources:
            source_one: true
            source_two: true
          timeout: 2
    
  • The enabled_plugins section of the xivo-confd service configuration has been changed. If you have configured enabled plugins manually you should update your manual configuration

    • This section is now a key-value setting.
    • All plugins have been renamed without the suffix _plugins.
    old.yml
    enabled_plugins:
      - user_plugin
      - conference_plugin
    
    new.yml
    enabled_plugins:
      user: true
      conference: true
    
  • There is a new channelvars option in /etc/asterisk/manager.d/99-general.conf. If you have manually configured channelvars already, you will have to manually merge the Wazo version with your version for them to work together.

Consult the 17.17 Roadmap for more information.

17.16

  • You must update the Wazo Client to 17.16. See the Wazo Client compatibility table.

  • The enabled_plugins section of the wazo-auth service has been renamed enabled_backend_plugins and is now a dictionary.

    • If you have hand made configuration to modify the list of enabled backends it should be modified see /etc/wazo-auth/config.yml
  • The ldap_user backend in wazo-auth is now disabled in the base configuration file.

    • If you are using the ldap_user authentication backend a file with the following content should be added to /etc/wazo-auth/conf.d

      enabled_backend_plugins:
        ldap_user: true
      
  • The enabled_plugins section of the xivo-dird service is now a dictionary.

    • If you have hand made configuration to modify the list of enabled plugins, it should be modified see /etc/xivo-dird/config.yml
  • wazo-admin-ui has been upgraded to python3. All plugins by Wazo Team has been migrated, but if you have installed a non-official/custom plugin that add something to the new interface, it probably broken. To fix this, you must convert your plugin to python3 or wait an available upgrade from the maintainer.

  • If you have setup a custom X.509 certificate for HTTPS (e.g. from Let’s Encrypt), you have to update your config in /etc/xivo/custom/custom-certificate.yml, according to the updated documentation, namely for the config regarding websocketd.

Consult the 17.16 Roadmap for more information.

17.15

  • xivo-call-logd has been renamed wazo-call-logd
    • The custom configuration has been moved to /etc/wazo-call-logd/conf.d/.
    • The log file has been renamed to wazo-call-logd.log.
    • The NGINX proxy has been recreated in /etc/nginx/locations/https-enabled/wazo-call-logd
  • Asterisk has been upgraded to version 15.0.0
    • If you have installed asterisk modules manually, you will have to install the asterisk 15 version, otherwise Asterisk will crash when starting.

Consult the 17.15 Roadmap for more information.

17.14

  • xivo-auth has been renamed wazo-auth
    • If you have developed a xivo-auth authentication backend the name of the entry point has changed to wazo_auth.backends. You should make this modification in your plugin’s setup.py file in the entry_point section.
    • If your custom development use service discovery to find xivo-auth, you will have to search for the wazo-auth service instead of xivo-auth.
  • We released a new version of the CTI client, rebranded as Wazo Client 17.14.1. It is compatible with all previous versions of Wazo (i.e. not before 16.16). See also the compatibility table.

Consult the 17.14 Roadmap for more information.

17.13

Consult the 17.13 Roadmap for more information.

17.12

Consult the 17.12 Roadmap for more information.

17.11

  • wazo-plugind REST API version 0.1 has been deprecated and will be removed in Wazo 18.02. See changelog for version REST API changelog

Consult the 17.11 Roadmap for more information.

17.10

Consult the 17.10 Roadmap for more information.

17.09

  • Codecs can now be customized in the /etc/asterisk/codecs.d/ directory. If you had custom configuration in /etc/asterisk/codecs.conf you will have to create a new file in codecs.d to use your customized configuration. A file named codecs.conf.dpkg-old will be left in /etc/asterisk if this operation is required.

  • Provd plugins from the addons repository have been merged into the main plugin repository. If you were using the addons repository you can safely switch back to the stable repository. See Alternative plugins repository for more details.

  • The command xivo-call-logs has been deprecated in favor of wazo-call-logs.

  • The command xivo-service has been deprecated in favor of wazo-service.

  • If you have a custom certificate configured, you will need to add a new symlink for the new daemon wazo-webhookd:

    ln -s "/etc/xivo/custom/custom-certificate.yml" "/etc/wazo-webhookd/conf.d/010-custom-certificate.yml"
    

Consult the 17.09 Roadmap for more information.

17.08

  • The call logs has been improved by adding date_end and date_answer informations. If you want to add these new informations to the old call logs, you need to regenerate them. For example, to regenerate the last month of call logs:

    xivo-call-logs delete -d 30
    xivo-call-logs generate -d 30
    

    This is only useful if you plan to use the call logs REST API to read calls that have been placed before the upgrade.

  • If you have setup a custom X.509 certificate for HTTPS (e.g. from Let’s Encrypt), you have to update your config in /etc/xivo/custom/custom-certificate.yml, according to the updated documentation, namely for the config regarding plugind.

Consult the 17.08 Roadmap for more information.

17.07

Consult the 17.07 Roadmap for more information.

17.06

  • Upgrade from version older than 13.01 are not supported anymore.

Consult the 17.06 Roadmap for more information.

17.05

  • python-flask-cors has been updated from 1.10.3 to 3.0.2. Configuration files with custom allow_headers will have to be updated to the new syntax. The following command can be used to see if you have a configuration file which needs to be updated.

    for f in $(find /etc/*/conf.d -name '*.yml'); do grep -H allow_headers $f; done
    

    The old config in /etc/xivo-*/conf.d looked like:

    rest_api:
      cors:
        allow_headers: Content-Type, X-Auth-Token
    

    The new config in /etc/xivo-*/conf.d looks like:

    rest_api:
      cors:
        allow_headers: ["Content-Type", "X-Auth-Token"]
    

    See also the reference ticket #6617.

Consult the 17.05 Roadmap for more information.

17.04

Consult the 17.04 Roadmap for more information.

17.03

Consult the 17.03 Roadmap for more information.

17.02

  • A few more services are now available by default on port TCP/443 (the complete list is documented in the Nginx section). This does not pose any additional security risk by default, but if you have extra strict requirements about security, they can be manually disabled.

Consult the 17.02 Roadmap for more information.

17.01

Consult the 17.01 Roadmap for more information.

16.16

Wazo 16.16 is the first public release of the project under the Wazo name. It is also the first release of Wazo under the “phoenix” codename.

  • A special procedure is required to upgrade from XiVO to Wazo.
  • Asterisk has been upgraded from version 13.11.2 to 14.2.1, which is a major Asterisk upgrade.
  • If you are using custom sheets that are stored locally, they must now be readable by the system user xivo-ctid. Make sure that this user has read access to the UI file of your custom sheets.
  • Switchboard statistics have been removed. The existing statistics data remain in the database for later migration but no more statistics will be collected.
  • The conference destination type in incalls REST API has been renamed to meetme.
  • The phonebook has been migrated from the web interface to xivo-dird. The phonebook contacts from the web interface have been moved to new dird-phonebooks. For users with many entities on the same Wazo, this will create one phonebook for each entity. The configuration has been updated to keep the previous behavior. No manual actions are required for installations with only one entity or if one phonebook by entity is the desired configuration. If only one phonebook is desired for all entities, some of the duplicate phonebooks can be deleted from the web interface and their matching configuration can also be removed.
    • The list of phonebooks can be modified in Services ‣ IPBX ‣ IPBX services ‣ Phonebook
    • The list of phonebooks sources can be modified in:
      • Configuration ‣ Management ‣ Directories
      • Services ‣ CTI Server ‣ Directories ‣ Definitions
    • The selected phonebooks for reverse lookups can be modified in Services ‣ CTI Server ‣ Directories ‣ Reverse directories
    • Direct directories can be modified in Services ‣ CTI Server ‣ Directories ‣ Direct directories

Please consult the following detailed upgrade notes for more information:

Consult the 16.16 Roadmap for more information.

16.13

XiVO 16.13 is the last public release of the project under the name XiVO.

  • Previously, a user’s DND was effective only if this user had DND enabled and the DND extension (*25 by default) was also enabled. Said differently, disabling the DND extension meant that no user could effectively be in DND. Starting from XiVO 16.13, a user’s DND is effective regardless of the state of the DND extension. The following features are impacted in the same way: call recording, incoming call filtering, forward on non-answer, forward on busy and unconditional forward.
  • If you have manually added nginx configuration files to the /etc/nginx/locations/http directory, you’ll need to move these files to /etc/nginx/locations/http-available and then create symlinks to them in the /etc/nginx/locations/http-enabled directory. This also applies to the https directory. See Nginx.
  • A regression has been introduced in the switchboard statistics. See issue 6443.

Consult the 16.13 Roadmap for more information.

16.12

Consult the 16.12 Roadmap for more information.

16.11

  • Fax reception: the “log” backend type has been removed. You should remove references to it in your /etc/xivo/asterisk/xivo_fax.conf if you were using it. Now, every time a fax is processed, a log line is added to /var/log/xivo-agid.log.

Consult the 16.11 Roadmap for more information.

16.10

  • The config file /etc/xivo/xivo-confgend.conf has been replaced with /etc/xivo-confgend/config.yml and /etc/xivo-confgend/conf.d. Custom modifications to this file are not migrated automatically, so manual intervention is required to migrate custom values to the conf.d directory. The file /etc/xivo/xivo-confgend/asterisk/contexts.conf has been moved to /etc/xivo-confgend/templates/contexts.conf, but custom modification are left untouched. See also Configuration Files for more details about configuration files in XiVO.

Consult the 16.10 Roadmap for more information.

16.09

  • The Wazo Client now uses xivo-ctid-ng to do transfers. Those new transfers cannot be cancelled with the *0 DTMF sequence and there is no interface in the Wazo Client to cancel a transfer for profiles other than the switchboard (bug #6321). This will be addressed in a later version.
  • Transfers started from the Wazo Client do not respect the Dial timeout on transfer option anymore (bug #6322). This feature will be reintroduced in a later version.

Consult the 16.09 Roadmap for more information.

16.08

  • CTI Protocol is now in version 2.2

  • Some security features have been added to the XiVO provisioning server. To benefit from these new features, you’ll need to update your xivo-provd plugins to meet the system requirements.

    If you have many phones that are connected to your XiVO through a NAT equipment, you should review the default configuration to make sure that the IP address of your NAT equipment don’t get banned unintentionally by your XiVO.

  • Newly created groups and queues now ignore call forward requests from members by default. Previously, call forward requests from members were always followed. This only applies to call forward configured directly on the member’s phone: call forward configured via *21 have always been ignored in these cases.

    Note that during the upgrade, the previous behaviour is kept for already existing queues and groups.

    This behaviour is now configurable per queue/group, via the “Ignore call forward requests from members” option under the “Application” tab. We recommend enabling this option.

Consult the 16.08 Roadmap for more information.

16.07

  • If you were affected by the bug #6213, i.e. if your agent login time statistics were incorrect since your upgrade to XiVO 15.20 or later, and you want to fix your statistics for that period of time, you’ll need to manually apply a fix.

Consult the 16.07 Roadmap for more information.

16.06

Consult the 16.06 Roadmap for more information.

16.05

  • The view, add, edit, delete and deleteall actions of the “lines” web service provided by the web interface have been removed. As a reminder, note that the web services provided by the web interface are deprecated.

Consult the 16.05 Roadmap for more information.

16.04

  • CTI Protocol is now in version 2.1
  • The field Rightcall Code from Services -> IPBX -> IPBX Settings -> Users under Services tab will overwrite all password call permissions for the user.
  • Faxes stored on FTP servers are now converted to PDF by default. See Using the FTP backend if you want to keep the old behavior of storing faxes as TIFF files.

Consult the 16.04 Roadmap for more information.

16.03

  • The new section Services ‣ Statistics ‣ Switchboard in the web interface will only be visible by a non-root administrator after adding the corresponding permissions in the administrator configuration.
  • Update the switchboard configuration page for the statistics in Configuration for multiple switchboards.
  • The API for associating a line to a device has been replaced. Consult the xivo-confd changelog for further details
  • The configuration parameters of xivo_ldap_user plugin of xivo-auth has been changed. See xivo_ldap plugin.
  • The user’s email is now a unique constraint. Every duplicate email will be deleted during the migration. (This does not apply to the voicemail’s email)

Consult the 16.03 Roadmap for more information.

16.02

  • The experimental xivo_ldap_voicemail plugin of xivo-auth has been removed. Use the new xivo_ldap plugin.
  • Bus messages in the xivo exchange are now sent with the content-type application/json. Some libraries already do the message conversion based the content-type. Kombu users will receive a python dictionnary instead of a string containing json when a message is received.
  • xivo-ctid encryption is automatically switched on for every XiVO server and Wazo Client >= 16.02. If you really don’t want encryption, you must disable it manually on the server after the upgrade. In that case, Wazo Clients will ask whether to accept the connection the first time.

Consult the 16.02 Roadmap for more information.

16.01

  • The page Configuration ‣ Management ‣ Web Services Access ‣ Acces rights has been removed. Consequently, every Web Services Access has now all access rights on the web services provided by the web interface. These web services are deprecated and will be removed soon.
  • During the upgrade, if no CA certificates were trusted at the system level, all the CA certificates from the ca-certificates package will be added. This is done to resolve an issue with installations from the ISO and PXE. In the (rare) case you manually configured the ca-certificates package to trust no CA certificates at all, you’ll need to manually reconfigure it via dpkg-reconfigure ca-certificates after the upgrade.
  • xivo-ctid uses xivo-auth to authenticate users. See Authentication.
  • the service_discovery section of the xivo-ctid configuration has changed. If you have set up Contact and Presence Sharing, you should update your xivo-ctid configuration.
  • the CTI Protocol is now versioned and a message will be displayed if the server and a client have incompatible protocol versions.

Consult the 16.01 Roadmap for more information.