This is an old revision of the document!

Table of Contents

Collaboration Services Administration

To install the ARDI Collaboration Services for a particular site or database, you'll need two installers.

1) The Collaboration Service installer, and
2) The Collaboration Addin installer

The first installs the actual collaboration services - the infrastructure to exchange messages between your various users.

The second installs the addin that allows you to point your ARDI server towards your collaboration server.

Install Collaboration Services

The collaboration services installer is designed for systems that already include the ARDI server. While it is possible to deploy the collaboration service on a standalone VM, Python 2.7 and several modules such as Twisted and Autobahn are required.

These can either be downloaded as wheels, or installed via PIP 

pip install twisted autobahn

To install on an ARDI server, you simply need to run the ARDI Collaboration Services installer.

This will install the required files and start a collaboration service on port 450.

Install & Configure the Collaboration Addin

1) Install the addin on the ARDI server machine
2) Go to Administration on the server web interface and choose 'Addons'.
3) Enable the 'Collaboration' addon.
4) Choose 'Collaboration Settings' in the Administration menu
5) Enter the server details for the collaboration server. The default port number is 450.
6) If you are sharing one collaboration server across multiple ARDI systems, you might also need to add a Default Group (usually named after your database).

For example, if you have Plant Alpha and Plant Beta as two separate databases but only want to deploy a single Collaboration server, those users can be given a default group of 'Alpha' and 'Beta', respectively.

Open Firewall Ports

By default, the Collaboration Server uses ports 450 (Mumble Control TCP Protocol), 451 (REST TCP Protocol) and 1229 (Voice UDP Protocol).

Clients such as ARDI-AR and ARDI-VE usually require access to port 450.

The ARDI server itself needs to be able to access the REST protocol (port 451). If this port is blocked between the ARDI server and the Collaboration server, a significant slowdown of web services will occur.