Workstream Collaboration BETA#

The WSC Role adds the chat functionality to Carbonio CE. It is currently in BETA version, hence it may still lack some functionalities and may not work 100% properly.

Install Packages#


In case you install this Role on a Node which already features the Mesh and Directory Role, make sure you do not install the service-discover-agent package.

# apt install postgresql-client carbonio-message-broker \
  carbonio-message-dispatcher carbonio-ws-collaboration-ce \
# dnf install carbonio-message-broker \
  carbonio-message-dispatcher carbonio-ws-collaboration-ce \

Install PostgreSQL repository

# dnf -y install

Install PostgreSQL client

# dnf -y install postgresql12

Bootstrap Carbonio CE#

# carbonio-bootstrap

The bootstrap command will execute a number of tasks and will set up the node. At the end, you will be prompted with a menu and, if you already configured all, you only need to click y for confirmation.

During the process, you need to provide these values, which you can retrieve from the first Mesh and Directory node.

  • Ldap master host is the FQDN of the first Mesh and Directory node, (example:

  • Ldap Admin password is obtained from the first Mesh and Directory node (ldap-admin-password)

Join Carbonio Mesh#

Carbonio Mesh is required to allow communication between Carbonio CE and its components. The configuration is interactively generated by command

# service-discover setup-wizard

This command will:

  • ask for the IP address and netmask

  • ask for the Carbonio Mesh secret, which is used for setups, management, and to access the administration GUI. See section Carbonio Mesh Administration Interface for more information.

    This password will be denoted as MESH_SECRET throughout the documentation.


    We suggest to use a robust password which is at least 16 characters long, including at least one of lowercase and uppercase letters, numbers, special characters and store it in a password manager.

    In case the password is lost or the credential file becomes corrupted and unusable, you can reset them using the procedure detailed in section Carbonio Mesh Credentials.

  • store the setup in file /etc/zextras/service-discover/cluster-credentials.tar.gpg

To complete Carbonio Mesh installation, run

# pending-setups -a


The secret needed to run the above command is stored in file /var/lib/service-discover/password, which is accessible only by the root user.

Migrate dispatcher#

Initialise the message dispatcher

# PGPASSWORD=$DB_ADM_PWD carbonio-message-dispatcher-migration \
  carbonio_adm 20000

Restart the service

# systemctl restart carbonio-message-dispatcher

Enable the Workstream Collaboration UI#

The Carbonio Workstream Collaboration role is disabled by default, you can enable it either from the Carbonio Admin Panel or from the command line by running as the zextras user the command

zextras$ carbonio prov mc default carbonioFeatureChatsEnabled TRU

This command enables the chat for the default COS, but you can enable it only on selected COSes.

Restart the service

# systemctl restart carbonio-ws-collaboration
Check status of Carbonio Workstream Collaboration

After the installation, you can check the status of and all its dependencies by running command

# curl -v | jq