Teamwork Cloud 18.5 SP3 Documentation

Skip to end of metadata
Go to start of metadata

This section explains how to install Teamwork Cloud (TWCloud) on a single server by using zip files and set up its configuration file to allow access to the authentication server. 


To install TWCloud on Windows by unzipping the file


  1. Verify that java –version is the active version of Java (Oracle JDK 1.8.0_152).
  2. Unzip the file to a directory, for example, C:\. Once you unzip the file, you will get the folder name C:\TeamworkCloudSuite.
  3. Open the server configuration file C:\TeamworkCloudSuite\configuration\application.conf and edit the following lines (the hostname, seed node, and host address respectively) to use the node's own IP address.

    hostname = "10.1.1.123"


    seed-nodes = ["akka.tcp://twcloud@10.1.1.123:2552"]


    host = "10.1.1.123"


    Also, update the following TWCloud configuration to allow access to the authentication server (protocol and ports are defaults).

    # Authentication Server address
    esi.auth {
    # Authentication Server protocol, IP address and port
    # InetAddress.getLocalHost.getHostAddress is used if server is left empty
    protocol = "https"
    server = "10.1.1.123"
    port = "8555"
     }


  4. Update the AuthServer configuration: <AuthServer install root>\config\authserver.properties by specifying the IP address instead <serverIP>:
server.public.host=<serverIP>
authentication.redirect.uri.whitelist=https://<serverIP>:8111>/twcloud_admin/,https://md_redirect
twc.server.host= <serverIP>


There are additional steps to run TWCloud 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 C:\TeamworkCloudSuite\configuration\logback.xml.

Note

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


To run TWCloud as a service 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 TWCloud was installed. 
    • JAVA_HOME is a directory containing a Java JDK or JRE. 

    For example:

        C:\> set TWCLOUD_HOME=C:\TeamworkCloudSuite
        C:\> set JAVA_HOME=C:\Program Files\Java\jre1.8.0_152

    Tip

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


  2.  Run the service installation script, for example: 

             C:\TeamworkCloudSuite\scripts\windows>installService.bat 


Info

  • It is best to run the script from a Command Prompt so it will be possible to read any errors that may be reported.
  • 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 service startup. Therefore, if the values are modified and the service must use the new values, the service must be re-installed.


To uninstall TWCloud as a service


  • Run the service uninstall script: 
     C:\TeamworkCloudSuite\scripts\windows\uninstallService.bat 


 

  • No labels