Installing Teamwork Cloud services

On this page

Installing Teamwork Cloud

Initial Installation

The deployment script for Teamwork Cloud (install_twc<version_number>_<os_version>.sh) creates a Teamwork Cloud user, under which the service will run, downloads all of the necessary files, and executes the installer. 

Before running the script, download the Teamwork Cloud installer file, twcloud_<version_number>_installer_linux64.bin, and place it in the same location as the script.

When you are installing Teamwork Cloud

1. Press ENTER until you will be asked to configure the machine IP.
2. Configure the machine IP - enter the local IP address of the machine (e.g. 192.168.130.10).
3. Configure the cluster seed node IP - enter the local IP address of the machine (e.g. 192.168.130.10). 
4. Configure the Teamwork Cloud service owner - enter twcloud. 
5. Configure JAVA_HOME - enter "/etc/alternatives/jre_11" without quotation marks.
6. Choose Install Folder - /opt/local/TeamworkCloud. 

Next, Teamwork Cloud Pre-Installation Summary will appear. It should look as follows:

===============================================================================
Pre-Installation Summary
------------------------
Please Review the Following Before Continuing:
 
Product Name:
    Teamwork Cloud
 
Install Folder:
    /opt/local/TeamworkCloud
 
Machine ip:
    "192.168.130.10"
 
Seed node ip:
    "192.168.130.10"
 
JAVA_HOME:
    "/etc/alternatives/jre_11"
 
Disk Space Information (for Installation Target):
    Required:  395,614,661 Bytes
    Available: 31,608,475,648 Bytes

Start all four services: authserver, twcloud, zookeeper, and webapp.

sudo systemctl start authserver
sudo systemctl start twcloud
sudo systemctl start zookeeper
sudo systemctl start webapp

To ensure the services start on reboot, execute the following commands:

sudo systemctl enable twcloud
sudo systemctl enable authserver
sudo systemctl enable zookeeper
sudo systemctl enable webapp

Post-install configuration (optional)

1. /opt/local/TeamworkCloud/configuration/application.conf - the configuration file for the Teamwork Cloud service.
   If Teamwork Cloud is installed behind a proxy or firewall with NAT, upon the initial connection the MagicDraw client must know the external IP address to which it must connect. Search for server-broadcast-host, and enter the public IP address instead of the local IP address. We now need to point Teamwork Cloud to the Cassandra database. Search for seeds = , which is located in the connection section. Edit the value inside the quotes to point to the listen_address you set in cassandra.yaml (i.e. seeds = ["192.168.130.10"]). A default password has been entered in the configuration file for its communication with the authorization server. It is recommended that it be changed. To do so, search for CHANGE_ME, which is associated with the field pswd, and replace it with a password of your choosing.

2. /opt/local/TeamworkCloud/AuthServer/config/authserver.properties - the configuration file for Authorization service.

   • server.public.host=public IP address (same as server-broadcast-host in application.conf). If you are accessing the server via an FQDN, use it instead of the IP address.
   • twc.server.host=local IP address.
   • cassandra.contactPoints=local IP address.
   • If you changed the pswd field in /opt/local/TeamworkCloud/configuration/application.conf from the default, you must modify this file accordingly. Search for authentication.client.secret. Remove the leading # (to uncomment the directive), and replace the CHANGE_ME value with the same value as that in application.conf.

   • If you are accessing the server by FQDN, you must edit the property authentication.redirect.uri.whitelist by adding an entry to whitelist the FQDN. For example: authentication.redirect.uri.whitelist=https://192.168.130.10:8443/,https://FQDN:8443/,https://md_redirect.

     Make sure that you add the public IP for both 8443 and 8111 ports to the whitelist.

3. /opt/local/TeamworkCloud/WebAppPlatform/shared/conf/webappplatform.properties - the configuration file for Teamwork Cloud Admin.
   
   • twc.admin.username - Set it to the username of a local account with Administrator privileges (default is Administrator).
   • twc.admin.password - Set it to the password corresponding to the Administrator user (default is Administrator).
   • If you changed the pswd field in /opt/local/TeamworkCloud/configuration/application.conf from the default, you must modify this file accordingly. Search for authentication.client.secret and replace the CHANGE_ME value with the same value as that in application.conf.