Teamwork Cloud 18.5 SP3 Documentation

Skip to end of metadata
Go to start of metadata

The configuration settings described in this section are optional. You only need to configure them if the default setting is not suitable for your environment. The Teamwork Cloud (TWCloud) system will load the configuration file every time it starts. Therefore, changes made to the configuration file will be applied once you restart it.

Setting TWAdmin password for Authentication Server

TWAdmin uses an Authentication Server to authenticate users. TWAdmin needs a password to access /token endpoint of the Authentication Server. Please specify the same password that is entered in the authentication server's configuration file authserver.properties (in authentication.client.secret parameter). The default value is CHANGE_ME.

esi.console {
....
#
# The console client password parameter.
client {
pswd = "CHANGE_ME"
}
...
}

Changing log file location

You can configure the logging system of TWCloud by using logback.xml. This file is located in the folder configuration of the TWCloud. You can change the name or location of the file by editing the following line in the file logback.xml.

  • In TWCloud, look for the following line:

<file>${user.home}/.twcloud/18.5 sp3/server.log</file>

When changing the log file name and location, you need to be sure that the user account to your Operating System (OS) that you will use to start TWCloud has the write permission in the new configured location. To learn more about logback configuration, see http://logback.qos.ch/manual/configuration.html.

Setting server port

The default port number of TWCloud for the client to connect to is 3579. However, the port number is changeable. If you would like to change the default port number, for example, to 3580, you can configure this in the TWCloud configuration file, application.conf Search for the content shown below.

esi {
	net
	{
		# The ip address to bind to
		# InetAddress.getLocalHost.getHostAddress is used if empty
		host = ""
		
		# Port for client application to connect to. 
		# This is corresponding to the port specified when connecting from client such as MagicDraw 
		port = 3579
	}

 

The configuration file, application.conf, is located in the directory configuration under the TWCloud program folder. For example, /opt/TeamworkCloud/TWCloud/configuration/application.conf. The configuration file is in HOCON format ("Human-Optimized Config Object Notation"). For more information about HOCON file format, visit the following link https://github.com/typesafehub/config/blob/master/HOCON.md#syntax.

Please note that MagicDraw is considered as a client of TWCloud. Consequently, if you change this setting, you will have to specify the port number while connecting from MagicDraw.

Setting public IP

If TWCloud is deployed in the environment where the client will connect to the server via a public IP, set the parameter server-broadcast-host to public IP address and host to the private IP. Search for the content in application.conf that looks like the following.

esi {

	net
	{
		# The ip address to bind to
		# InetAddress.getLocalHost.getHostAddress is used if empty
		host = ""

		# Port for client application to connect to. 
		# This is corresponding to the port specified when connecting from client such as MagicDraw 
		port = 3579

		# To support deploy TWCloud in private network but client connect from public network,
		# Specify IP address that will be used by client to connect to this TWCloud from public network
		# This value will be default to esi.net.host if it is empty
		server-broadcast-host = ""
	}
  • No labels