On this page:

The authentication server is part of Teamwork Cloud (TWCloud). You can deploy the authentication server onto your computer using the following instructions for Windows and Linux users. 

Authentication server deployment on Windows 

To deploy an authentication server using the zip file

  1. In the command prompt dialog, verify "java –version" is the active Java version, which is Oracle JDK 1.8.0_202.
  2. Go to the directory where TWCloud is unzipped and select the AuthServer directory.
  3. Update the file <TWCloud directory>/AuthServer/config/authserver.properties as follows:
    1. server.public.host - Enter the IP address of the authentication server in place of ${server.ip}. If TWCloud is installed behind a proxy or firewall with NAT, use a public IP address. If you are accessing the server via an FQDN, use it instead of the IP address.
    2. twc.server.host - Enter the IP address of the server where TWCloud is installed in place of ${twc.server.ip}.
    3. twc.server.port - Specify the port of TWCloud REST API (the default is 8111).
    4. twc.server.protocol - Specify the protocol of TWCloud REST API (the default is https).

    5. authentication.redirect.uri.whitelist - Update the whitelist of redirect URI. Also, change the TWCloud swager's redirect URI (the initial is https://${twc.server.ip}:8111/) by setting the TWCloud IP address or FQDN instead of ${twc.server.ip}. Change the Web App Platform redirect URI (the initial is https://${webapp.server.ip}:8443/webapp/) by setting the Web App Platform IP address or FQDN (if you are accessing the server by FQDN) instead of ${webapp.server.ip} (and change the port/protocol if they were changed).

    6. cassandra.contactPoints and cassandra.port - Update the Cassandra host(s) if the database is installed on a different machine(s) and the Cassandra port if the custom port is configured in the database for CQL clients listening.

  4. Save the authserver.properties file.
  5. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  6. Open the command prompt to <TWCloud directory>/AuthServer and run the file registerWindowsService.bat.
  7. Open the Windows Services panel or Task Manager's Services tab.
  8. Locate Authentication Server in the Windows Services panel (or AuthServer in Task Manager) and start it.


To deploy an authentication server using the installer

  1. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  2. By default, the Authentication Server will be started on the IP address specified during the installation process. If you want to access it through the public IP or FQDN, open the file <TWCloud directory>/AuthServer/config/authserver.properties and enter the public IP address or FQDN into the property server.public.host.
  3. Open the Windows Services panel or Task Manager's Services tab.
  4. Locate Authentication Server in the Windows Services panel (or AuthServer in Task Manager) and start it.


To undeploy an authentication server

  1. Open the Windows Services panel or Task Manager's Services tab.
  2. Locate Authentication Server in the Windows Services panel (or AuthServer in Task Manager) service and stop it.
  3. Open the command prompt to <TWCloud directory>/AuthServer and run the file unregisterWindowsService.bat.


Authentication server deployment on Linux

To deploy an authentication server using the zip file

  1. Go to the directory, where TWCloud is unzipped, and select the AuthServer directory.
  2. Update the file <TWCloud directory>/AuthServer/config/authserver.properties as follows.
    1. server.public.host - Enter the IP address of the authentication server in place of ${server.ip}. If TWCloud is installed behind a proxy or firewall with NAT, use a public IP address. If you are accessing the server via FQDN, use it instead of the IP address.
    2. twc.server.host - Enter the IP address of the server where TWCloud is installed in place of ${twc.server.ip}.
    3. twc.server.port - Specify the port of TWCloud REST API (the default is 8443).
    4. twc.server.protocol - Specify the protocol of TWCloud REST API (the default is https).

    5. authentication.redirect.uri.whitelist - Update the whitelist of redirect URI. Also, change the TWCloud swager's redirect URI (the initial is https://${twc.server.ip}:8111/) by setting the TWCloud IP address or FQDN instead of ${twc.server.ip}. Change the Web App Platform redirect URI (the initial is https://${webapp.server.ip}:8443/webapp/) by setting the Web App Platform IP address or FQDN (if you are accessing the server by FQDN) instead of ${webapp.server.ip} (and change the port/protocol if they were changed).

    6. cassandra.contactPoints and cassandra.port - Update the Cassandra host(s) if the database is installed on a different machine(s) and the Cassandra port if the custom port is configured in the database for CQL clients listening.

  3. Save the file authserver.properties.
  4. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  5. Copy the file <TWCloud directory>/AuthServer/script/authserver to the following directory /etc/ini.d: sudo cp <TWCloud directory>/AuthServer/script/authserver /etc/init.d.
  6. To make the service start/stop with system startup/shutdown, use the following command: sudo chkconfig --add authserver.
  7. Start the authentication server: sudo service authserver start.


To deploy an authentication server using the installer

  1. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  2. By default, the Authentication Server will be started on the IP address specified during the installation process. If you want to access it through the public IP or FQDN, open the file <TWCloud directory>/AuthServer/config/authserver.properties and enter the public IP address or FQDN into the property server.public.host.
  3. Start the authentication server: sudo service authserver start.


To undeploy an authentication server

  1. Type sudo service authserver stop to stop the authentication server.
  2. Remove the service from chkconfig management with this command: sudo chkconfig --del authserver.
  3. Remove the link by typing: sudo rm /etc/init.d/authserver.
  4. Remove the directory <TWCloud directory>/AuthServer.