On this page


This section explains how to install Magic Collaboration Studio on a single server by using zip files and setting up its configuration file to allow access to the authentication server.

Prerequisites

Installing Magic Collaboration Studio on Windows by unzipping the file


To install Magic Collaboration Studio on Windows by unzipping the file

  1. Unzip the contents of the TeamworkCloudSuite directory to the installation directory (for example, <install_root>\TeamworkCloud).

  2. Open the server configuration file <install_root>\TeamworkCloud\configuration\application.conf and edit the following lines (the hostname and seed-nodes) to use the node's own IP address.
    You must also set the IP address of the Cassandra node in the seeds section. If your Cassandra instance is on the same server, then use the node's own IP address.

    hostname = "10.1.1.123"
    ### Configuration for the Netty based transport drivers
	artery.canonical {
 		# The hostname or ip clients should connect to.
 		# If it is not set, it will be set automatically to the IP that can connect to the seed node.
		hostname = "10.1.1.123"

		# The default remote server port clients should connect to.
      		# Default is 2552 (AKKA). Use 0 if you want a random available port.
      		# This port needs to be unique for each actor system on the same machine.
		port = 2552
    seed-nodes = ["akka://twcloud@10.1.1.123:2552"]
    cluster {
		# Initial contact points of the cluster.
    		# The nodes to join automatically at startup.
    		# The comma separating full URIs defined by a String in the form of
    		# "akka://system@hostname:port"
		# Can be set by system property. 
		# e.g. ["akka://twcloud@10.1.1.123:2552","akka://twcloud@10.1.1.124:2552"]
		# The default value depends on the operation mode. In cluster mode, the seed node is mandatory in all nodes.
		# In single server mode, the seed node configuration is optional. It is set to 127.0.0.1 by default at runtime.
		seed-nodes = ["akka://twcloud@10.1.1.123:2552"]
    contact-points = ["10.1.1.123:9042"]
    esi.persistence.datastax-java-driver {
                basic {
                                contact-points = ["10.1.1.123:9042"]

  3. Update the AuthServer configuration: <install_root>\shared\conf\authserver.properties by specifying the IP address instead of <serverIP>:

    authentication.redirect.uri.whitelist=https://<serverIP>:8443>/
twc.server.host=<serverIP>

     

  4. Update the configuration file: <install_root>\TeamworkCloud\WebAppPlatform\shared\conf\webappplatform.properties - the configuration file for Teamwork Cloud Admin Console
    • 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 <install_root>\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.


  5. Generate default keypair and certificate by running the following command from the command prompt. If your TeamworkCloudSuite is under a folder that requires Administrative permission, for example, C:\Program Files, make sure that you start the command prompt using "Run as administrator".

    C:\> cd C:\TeamworkCloudSuite\scripts\windows
C:\> genkey
If the server is accessed via FQDN or public IP address, then the authentication.redirect.url must also contain entries for them, accordingly, in the format:
authentication.redirect.uri.whitelist=https://<serverIP>:8443>/webapp/,https://<PublicIP>:8443>/webapp/,https://<FQDN>:8443>/webapp/,https://md_redirect/

There are additional steps to run Magic Collaboration Studio as a service on Windows. Before proceeding, make sure the server's log configuration points to the file location that is writable. You can find the log config in the file <install_root>\TeamworkCloud\configuration\logback.xml.

You need to check if the file location path is editable.

Running Magic Collaboration Studio on Windows

To run Magic Collaboration Studio on Windows

  1. Set the necessary environment variables in the shell that will execute the service installation script where:
    • TWCLOUD_HOME is the path that points to the directory where Magic Collaboration Studio was installed. 
    • JAVA_HOME is a directory containing a Java JDK or JRE. 

    For example:

    C:\> set TWCLOUD_HOME=C:\Program Files\TeamworkCloud
C:\> set JAVA_HOME=C:\Program Files\Java\jdk-11.0.12+7

    Alternatively, set the environment variables by adding them through the Environment Variables dialog (click Control Panel > System > Advanced > Environment Variables > New). 

  2.  Run the Magic Collaboration Studio service installation script, for example: 

    C:\Program Files\TeamworkCloud\scripts\windows>installService.bat

  3. Run the WebApp and the Zookeeper service installation script

    • The WebApp service requires its bundled Java.  Therefore, prior to executing the service install script, we must set JRE_HOME and CATALINA_HOME_WEBAPP to point to it.

      C:\> set JRE_HOME=C:\Program Files\TeamworkCloud\WebAppPlatform\jre 
C:\> set CATALINA_HOME_WEBAPP=C:\Program Files\TeamworkCloud\WebAppPlatform
C:\Program Files\TeamworkCloud\WebAppPlatform\bin\>service.bat install 
C:\Program Files\TeamworkCloud\WebAppPlatform\zookeeper\bin\>zkService.cmd install

  4. Set service dependencies:

    C:\> sc config webapp depend= teamworkcloud
  • The scripts should be executed from an elevated command prompt (Run as Administrator).
  • On Windows, the values of the environment variables are evaluated only once, when the service is installed. Subsequent changes to these variables will not affect the service startup. Therefore, if the values are modified and the service must use the new values, the service must be re-installed.

Uninstalling Magic Collaboration Studio on Windows

To uninstall Magic Collaboration Studio:

  • Run the service uninstallation scripts: 
C:\Program Files\TeamworkCloud\scripts\windows>uninstallService.bat 
C:\Program Files\TeamworkCloud\AuthServer\bin\unregisterWindowsService.bat
C:\Program Files\TeamworkCloud\WebAppPlatform\bin\>service.bat uninstall 
C:\Program Files\TeamworkCloud\WebAppPlatform\zookeeper\bin\>zkService.cmd remove